diff --git a/www/apps/api-reference/.env.sample b/www/apps/api-reference/.env.sample
index 8431f8b0f8..bfa84af2aa 100644
--- a/www/apps/api-reference/.env.sample
+++ b/www/apps/api-reference/.env.sample
@@ -10,10 +10,10 @@ NEXT_PUBLIC_DOCS_URL=
NEXT_PUBLIC_UI_URL=
NEXT_PUBLIC_RESOURCES_URL=
NEXT_PUBLIC_USER_GUIDE_URL=
+NEXT_PUBLIC_DOCS_V1_URL=
+NEXT_PUBLIC_API_V1_URL=
ALGOLIA_WRITE_API_KEY=
ANALYZE_BUNDLE=
NEXT_PUBLIC_AI_ASSISTANT_URL=
NEXT_PUBLIC_AI_WEBSITE_ID=
-NEXT_PUBLIC_AI_API_ASSISTANT_RECAPTCHA_SITE_KEY=
-NEXT_PUBLIC_VERSIONING=
-NEXT_PUBLIC_SHOW_V2=
\ No newline at end of file
+NEXT_PUBLIC_AI_API_ASSISTANT_RECAPTCHA_SITE_KEY=
\ No newline at end of file
diff --git a/www/apps/api-reference/app/_mdx/v2/admin.mdx b/www/apps/api-reference/app/_mdx/admin.mdx
similarity index 100%
rename from www/apps/api-reference/app/_mdx/v2/admin.mdx
rename to www/apps/api-reference/app/_mdx/admin.mdx
diff --git a/www/apps/api-reference/app/_mdx/v2/client-libraries.mdx b/www/apps/api-reference/app/_mdx/client-libraries.mdx
similarity index 100%
rename from www/apps/api-reference/app/_mdx/v2/client-libraries.mdx
rename to www/apps/api-reference/app/_mdx/client-libraries.mdx
diff --git a/www/apps/api-reference/app/_mdx/v2/store.mdx b/www/apps/api-reference/app/_mdx/store.mdx
similarity index 100%
rename from www/apps/api-reference/app/_mdx/v2/store.mdx
rename to www/apps/api-reference/app/_mdx/store.mdx
diff --git a/www/apps/api-reference/app/_mdx/v1/admin.mdx b/www/apps/api-reference/app/_mdx/v1/admin.mdx
deleted file mode 100644
index 958a9d43b0..0000000000
--- a/www/apps/api-reference/app/_mdx/v1/admin.mdx
+++ /dev/null
@@ -1,1224 +0,0 @@
-import { Feedback, CodeTabs, CodeTab } from "docs-ui"
-import SectionContainer from "@/components/Section/Container"
-import formatReportLink from "@/utils/format-report-link"
-
-
-
-This API reference includes Medusa's Admin APIs, which are REST APIs exposed by the Medusa backend. They are typically used to perform admin functionalities or create an admin dashboard to access and manipulate your commerce store's data.
-
-All API Routes are prefixed with `/admin`. So, during development, the API Routes will be available under the path `http://localhost:9000/admin`. For production, replace `http://localhost:9000` with your Medusa backend URL.
-
-There are different ways you can send requests to these API Routes, including:
-
-- Using Medusa's [JavaScript Client](https://docs.medusajs.com/js-client/overview)
-- Using the [Medusa React](https://docs.medusajs.com/medusa-react/overview) library
-- Using cURL
-
-Aside from this API reference, check out the [Commerce Modules](https://docs.medusajs.com/modules/overview) section of the documentation for guides on how to use these APIs in different scenarios.
-
-
-
-
-
-
-
-## Authentication
-
-There are three ways to send authenticated requests to the Medusa server: Using a user's API token, using a JWT token or using a Cookie Session ID.
-
-### API Token
-
-Use a user's API Token to send authenticated requests.
-
-#### How to Add API Token to a User
-
-You can use the Update User API Route to add or update the user's API token:
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.users.update(userId, {
- api_token
- })
- .then(({ user }) => {
- console.log(user.api_token)
- })
- ```
-
-
-
-
- ```tsx
- import { useAdminUpdateUser } from "medusa-react"
-
- const UpdateUser = () => {
- const updateUser = useAdminUpdateUser(userId)
- // ...
-
- const handleUpdateUser = () => {
- updateUser.mutate({
- api_token
- })
- }
-
- // ...
- }
-
- export default UpdateUser
- ```
-
-
-
-
- ```bash
- curl -L -X POST '/admin/users/' \\
- -H 'Cookie: connect.sid={sid}' \\
- -H 'Content-Type: application/json' \\
- --data-raw '{
- "api_token": "{api_token}"
- }'
- ```
-
-
-
-
-
-#### How to Use the API Token
-
-
-The API token can be used by providing it in `x-medusa-access-token` header:
-
-```bash
-x-medusa-access-token: {api_token}
-```
-
-You can also pass it to client libraries:
-
-
-
-
- ```ts
- const medusa = new Medusa({
- baseUrl: MEDUSA_BACKEND_URL,
- maxRetries: 3,
- apiKey: '{api_token}'
- })
- ```
-
-
-
-
- ```tsx
-
- {/* ... */}
-
- ```
-
-
-
-
-### JWT Token
-
-Use a JWT token to send authenticated requests. Authentication state is managed by the client, which is ideal for Jamstack applications and mobile applications.
-
-#### How to Obtain the JWT Token
-
-JWT tokens are obtained by sending a request to the [User Login (JWT) API Route](#auth_posttoken) passing it the user's email and password in the request body. For example:
-
-```bash
-curl -X POST 'https://medusa-url.com/admin/auth/token' \
--H 'Content-Type: application/json' \
---data-raw '{
- "email": "user@example.com",
- "password": "supersecret"
-}'
-```
-
-If authenticated successfully, an object is returned in the response with the property `access_token` being the JWT token.
-
-#### How to Use the JWT Token
-
-The JWT token can be used for Bearer Authentication. It's passed in the
-`Authorization` header as the following:
-
-
-```bash
-Authorization: Bearer {jwt_token}
-```
-
-### Cookie Session ID
-
-Use a cookie session to send authenticated requests.
-
-### How to Obtain the Cookie Session
-
-
-If you're sending requests through a browser, using Medusa's JS and Medusa React clients, or using
-tools like Postman, the cookie session should be automatically set when
-the admin user is logged in.
-
-
-If you're sending requests using cURL, you must set the Session ID in
-the cookie manually.
-
-
-To do that, send a request to [authenticate the
-user](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`:
-
-
-```bash
-curl -v -X POST 'https://medusa-url.com/admin/auth' \
--H 'Content-Type: application/json' \
---data-raw '{
- "email": "user@example.com",
- "password": "supersecret"
-}'
-
-```
-
-
-The headers will be logged in the terminal as well as the response. You
-should find in the headers a Cookie header similar to this:
-
-
-```bash
-Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM;
-```
-
-
-Copy the value after `connect.sid` (without the `;` at the end) and pass
-it as a cookie in subsequent requests as the following:
-
-
-```bash
-curl 'https://medusa-url.com/admin/products' \
--H 'Cookie: connect.sid={sid}'
-```
-
-
-Where `{sid}` is the value of `connect.sid` that you copied.
-
-If you're sending requests using JavaScript's Fetch API, you must pass the `credentials` option
-with the value `include` to all the requests you're sending. For example:
-
-```js
-fetch(`/admin/products`, {
- credentials: "include",
-})
-```
-
-
-
-
-
-
-
-## HTTP Compression
-
-If you've enabled HTTP Compression in your Medusa configurations, and you
-want to disable it for some requests, you can pass the `x-no-compression`
-header in your requests:
-
-```bash
-x-no-compression: true
-```
-
-If you're using the Medusa JS Client, you can pass custom headers in the
-last parameter of a method. For example:
-
-```ts
-medusa.products.list({}, {
- "x-no-compression": true
-})
-.then(({ products, limit, offset, count }) => {
- console.log(products.length)
-})
-```
-
-You can also pass the header when you first initialize the Medusa client:
-
-```ts
-const medusa = new Medusa({
- maxRetries: 3,
- baseUrl: "https://api.example.com",
- customHeaders: {
- "x-no-compression": true
- }
-})
-```
-
-For Medusa React, it's not possible to pass custom headers for a query or mutation, but
-you can pass the header to the `MedusaProvider` and it will be added to all subsequent requests:
-
-```tsx
-import { MedusaProvider } from "medusa-react"
-
-// define query client...
-
-const App = () => {
- return (
-
-
-
- )
-}
-```
-
-
-
-
-
-
-
-## Expanding Relations
-
-Many API Routes accept an `expand` that unpacks an
-entity's relations and return them in the response.
-
-
-
-
-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, retrieve their collection
-by passing to the `expand` query parameter the value `collection`:
-
-
-
-
- ```bash
- curl "http://localhost:9000/admin/products?expand=collection" \
- -H 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- expand: "collection"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- expand: "collection"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### Expanding Multiple Relations
-
-
-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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- expand: "variants,collection"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- expand: "variants,collection"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-### Expanding Nested Relations
-
-
-Expand nested relations (the relations of a relation) using dot notation.
-
-
-For example, to retrieve the variants of a product along with its option values,
-pass to the `expand` query parameter `variants.options`:
-
-
-
-
- ```bash
- curl "http://localhost:9000/admin/products?expand=variants.options" \
- -H 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- expand: "variants.options"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- expand: "variants.options"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### 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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- expand: ""
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- expand: ""
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-This would retrieve each product with only its properties, without any
-relations like `collection`.
-
-
-
-
-
-
-
-## Selecting Fields
-
-
-In many API Routes you'll find a `fields` query parameter that can be passed
-to the API Route. 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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- fields: "title"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- fields: "title"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- fields: "title",
- expand: ""
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- fields: "title",
- expand: ""
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### 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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- fields: "title,handle"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- fields: "title,handle"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### 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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- fields: ""
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- fields: ""
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- fields: "",
- expand: ""
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- fields: "",
- expand: ""
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-
-
-
-
-
-## 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 routes and not using
-the JS Client. For example, when using cURL or Postman.
-
-
-### Strings
-
-
-You can pass a string value in the form of `=`.
-
-
-For example:
-
-
-```bash
-curl "http://localhost:9000/admin/products?title=Shirt" \
--H 'x-medusa-access-token: {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 'x-medusa-access-token: {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 `=`.
-
-
-For example:
-
-
-```bash
-curl "http://localhost:9000/admin/products?offset=1" \
--H 'x-medusa-access-token: {api_token}'
-```
-
-
-### Boolean
-
-
-You can pass a boolean value in the form of `=`.
-
-
-For example:
-
-
-```bash
-curl "http://localhost:9000/admin/products?is_giftcard=true" \
--H 'x-medusa-access-token: {api_token}'
-```
-
-
-### Date and DateTime
-
-
-You can pass a date value in the form `=`. 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 'x-medusa-access-token: {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 'x-medusa-access-token: {api_token}'
-```
-
-
-### Array
-
-
-Each array value must be passed as a separate query parameter in the form
-`[]=`. You can also specify the index of each
-parameter in the brackets `[0]=`.
-
-
-For example:
-
-
-```bash
-curl -g "http://localhost:9000/admin/products?sales_channel_id[]=sc_01GPGVB42PZ7N3YQEP2WDM7PC7&sales_channel_id[]=sc_234PGVB42PZ7N3YQEP2WDM7PC7" \
--H 'x-medusa-access-token: {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
-`[]=`.
-
-
-For example:
-
-
-```bash
-curl -g "http://localhost:9000/admin/products?created_at[lt]=2023-02-17&created_at[gt]=2022-09-17" \
--H 'x-medusa-access-token: {api_token}'
-```
-
-
-
-
-
-
-
-## Pagination
-
-### Query Parameters
-
-
-In listing API Routes, 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 API Route:
-
-
-
-
- ```bash
- curl "http://localhost:9000/admin/products?limit=5" \
- -H 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- limit: 5
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- limit: 5
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### Response Fields
-
-
-In the response of listing API Routes, aside from the entities retrieved,
-there are three pagination-related fields returned:
-
-
-- `limit`: the maximum number of items that can be returned in the response.
-- `offset`: the number of items that were skipped before the entities in the result.
-- `count`: 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 API Routes 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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- order: "created_at"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- order: "created_at"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-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 'x-medusa-access-token: {api_token}'
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list({
- order: "-created_at"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts({
- order: "-created_at"
- })
-
- return (
-
- {/** ... **/}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-This sorts the products by their `created_at` attribute in the descending
-order.
-
-
-
-
\ No newline at end of file
diff --git a/www/apps/api-reference/app/_mdx/v1/client-libraries.mdx b/www/apps/api-reference/app/_mdx/v1/client-libraries.mdx
deleted file mode 100644
index bbaa99b23d..0000000000
--- a/www/apps/api-reference/app/_mdx/v1/client-libraries.mdx
+++ /dev/null
@@ -1,34 +0,0 @@
-import { CodeTabs, CodeTab } from "docs-ui"
-import Space from "@/components/Space"
-import DownloadFull from "@/components/DownloadFull"
-
-### Just Getting Started?
-
-Check out the [quickstart guide](https://docs.medusajs.com/create-medusa-app).
-
-
-
-### Client Libraries
-
-
-
-
- ```bash
- npm install @medusajs/medusa-js
- ```
-
-
-
-
- ```bash
- npm install medusa-react @tanstack/react-query @medusajs/medusa
- ```
-
-
-
-
-### Download Full Reference
-
-Download this reference as an OpenApi YAML file. You can import this file to tools like Postman and start sending requests directly to your Medusa backend.
-
-
\ No newline at end of file
diff --git a/www/apps/api-reference/app/_mdx/v1/store.mdx b/www/apps/api-reference/app/_mdx/v1/store.mdx
deleted file mode 100644
index b5ef864b71..0000000000
--- a/www/apps/api-reference/app/_mdx/v1/store.mdx
+++ /dev/null
@@ -1,1177 +0,0 @@
-
-import { Feedback, CodeTabs, CodeTab } from "docs-ui"
-import SectionContainer from "@/components/Section/Container"
-import formatReportLink from "@/utils/format-report-link"
-
-
-
-This API reference includes Medusa's Store APIs, which are REST APIs exposed by the Medusa backend. They are typically used to create a storefront for your commerce store, such as a webshop or a commerce mobile app.
-
-All API Routes are prefixed with `/store`. So, during development, the API Routes will be available under the path `http://localhost:9000/store`. For production, replace `http://localhost:9000` with your Medusa backend URL.
-
-There are different ways you can send requests to these API Routes, including:
-
-- Using Medusa's [JavaScript Client](https://docs.medusajs.com/js-client/overview)
-- Using the [Medusa React](https://docs.medusajs.com/medusa-react/overview) library
-- Using cURL
-
-Aside from this API reference, check out the [Commerce Modules](https://docs.medusajs.com/modules/overview) section of the documentation for guides on how to use these APIs in different scenarios.
-
-
-
-
-
-
-
-## Authentication
-
-There are two ways to send authenticated requests to the Medusa server: Using a JWT token or using a Cookie Session ID.
-
-### JWT Token
-
-Use a JWT token to send authenticated requests. Authentication state is managed by the client, which is ideal for Jamstack applications and mobile applications.
-
-#### How to Obtain the JWT Token
-
-JWT tokens are obtained by sending a request to the [Customer Login (JWT) API Route](#auth_authtoken) passing it the customer's email and password in the request body. For example:
-
-```bash
-curl -X POST 'https://medusa-url.com/store/auth/token' \
--H 'Content-Type: application/json' \
---data-raw '{
- "email": "user@example.com",
- "password": "supersecret"
-}'
-
-```
-
-If authenticated successfully, an object is returned in the response with the property `access_token` being the JWT token.
-
-#### How to Use the JWT Token
-
-The JWT token can be used for Bearer Authentication. It's passed in the
-`Authorization` header as the following:
-
-
-```bash
-Authorization: Bearer {jwt_token}
-```
-
-### Cookie Session ID
-
-Use a cookie session to send authenticated requests.
-
-#### How to Obtain the Cookie Session
-
-
-If you're sending requests through a browser, using Medusa's JS and Medusa React clients, or using
-tools like Postman, the cookie session should be automatically set when
-the customer is logged in.
-
-
-If you're sending requests using cURL, you must set the Session ID in
-the cookie manually.
-
-
-To do that, send a request to [authenticate the
-customer](#tag/Auth/operation/PostAuth) and pass the cURL option `-v`:
-
-
-```bash
-curl -v -X POST 'https://medusa-url.com/store/auth' \
--H 'Content-Type: application/json' \
---data-raw '{
- "email": "user@example.com",
- "password": "supersecret"
-}'
-```
-
-
-The headers will be logged in the terminal as well as the response. You
-should find in the headers a Cookie header similar to this:
-
-
-```bash
-Set-Cookie: connect.sid=s%3A2Bu8BkaP9JUfHu9rG59G16Ma0QZf6Gj1.WT549XqX37PN8n0OecqnMCq798eLjZC5IT7yiDCBHPM;
-```
-
-
-Copy the value after `connect.sid` (without the `;` at the end) and pass
-it as a cookie in subsequent requests as the following:
-
-
-```bash
-curl 'https://medusa-url.com/store/customers/me/orders' \
--H 'Cookie: connect.sid={sid}'
-```
-
-Where `{sid}` is the value of `connect.sid` that you copied.
-
-If you're sending requests using JavaScript's Fetch API, you must pass the `credentials` option
-with the value `include` to all the requests you're sending. For example:
-
-```js
-fetch(`/admin/products`, {
- credentials: "include",
-})
-```
-
-
-
-
-
-
-
-## Publishable API Key
-
-Publishable API Keys allow you to send a request with a pre-defined scope. You can associate the
-publishable API key with one or more resources, such as sales channels, then include the publishable
-API key in the header of your requests.
-
-The Medusa backend will infer the scope of the current
-request based on the publishable API key. At the moment, publishable API keys only work with sales channels.
-
-It's highly recommended to create a publishable API key and pass it in the header of all your requests to the
-store APIs.
-
-You can learn more about publishable API keys and how to use them in [this documentation](https://docs.medusajs.com/development/publishable-api-keys/).
-
-### How to Create a Publishable API Key
-
-You can create a publishable API key either using the [admin REST APIs](https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys),
-or using the [Medusa Admin](https://docs.medusajs.com/user-guide/settings/publishable-api-keys).
-
-### How to Use a Publishable API Key
-
-You can pass the publishable API key in the header `x-publishable-api-key` in all your requests to the store APIs:
-
-```bash
-x-publishable-api-key: {your_publishable_api_key}
-```
-
-If you're using Medusa's JS or Medusa React clients, you can pass the publishable API key when you first
-initialize either clients. Then, the publishable API key will be automatically included in all your requests:
-
-
-
-
- ```ts
- const medusa = new Medusa({
- maxRetries: 3,
- baseUrl: "https://api.example.com",
- publishableApiKey,
- })
- ```
-
-
-
-
- ```tsx
- import { MedusaProvider } from "medusa-react"
-
- // define query client...
-
- const App = () => {
- return (
-
-
-
- )
- }
- ```
-
-
-
-
-
-
-
-
-
-
-## HTTP Compression
-
-If you've enabled HTTP Compression in your Medusa configurations, and you
-want to disable it for some requests, you can pass the `x-no-compression`
-header in your requests:
-
-```bash
-x-no-compression: true
-```
-
-If you're using the Medusa JS Client, you can pass custom headers in the
-last parameter of a method. For example:
-
-```ts
-medusa.products.list({}, {
- "x-no-compression": true
-})
-.then(({ products, limit, offset, count }) => {
- console.log(products.length)
-})
-```
-
-You can also pass the header when you first initialize the Medusa client:
-
-```ts
-const medusa = new Medusa({
- maxRetries: 3,
- baseUrl: "https://api.example.com",
- customHeaders: {
- "x-no-compression": true
- }
-})
-```
-
-For Medusa React, it's not possible to pass custom headers for a query or mutation, but
-you can pass the header to the `MedusaProvider` and it will be added to all subsequent requests:
-
-```tsx
-import { MedusaProvider } from "medusa-react"
-
-// define query client...
-
-const App = () => {
- return (
-
-
-
- )
-}
-```
-
-
-
-
-
-
-
-## Expanding Relations
-
-
-Many API Routes accept an `expand` that unpacks an
-entity's relations and return them in the response.
-
-
-
-
-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 list of products, retrieve their collections by
-passing to the `expand` query parameter the value `collection`:
-
-
-
-
- ```bash
- curl "http://localhost:9000/store/products?expand=collection"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- expand: "collection"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- expand: "collection"
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-### Expanding Multiple Relations
-
-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 the products,
-pass to the `expand` query parameter the value `variants,collection`:
-
-
-
-
- ```bash
- curl "http://localhost:9000/store/products?expand=variants,collection"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- expand: "variants,collection"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- expand: "variants,collection"
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-### Expanding Nested Relations
-
-
-Expand nested relations (the relations of a relation) using dot notation.
-
-
-For example, to retrieve the variants of a product along with its option values,
-pass to the `expand` query parameter `variants.options`:
-
-
-
-
- ```bash
- curl "http://localhost:9000/store/products?expand=variants.options"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- expand: "variants.options"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- expand: "variants.options"
- })
-
- return (
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-This would retrieve the products with only their properties, without any
-relations like `collection`.
-
-
-
-
-
-
-
-## Selecting Fields
-
-
-In many API Routes you'll find a `fields` query parameter that can be passed
-to the API Route. 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"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- fields: "title"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- fields: "title"
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-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"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- fields: "title",
- expand: ""
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- fields: "title",
- expand: ""
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### 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 the products:
-
-
-
-
- ```bash
- curl "http://localhost:9000/store/products?fields=title,handle"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- fields: "title,handle"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- fields: "title,handle"
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### 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"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- fields: ""
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- fields: ""
- })
-
- return (
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-
-
-
-
-
-## 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 Routes and not using
-our JS Client. For example, when using cURL or Postman.
-
-
-### Strings
-
-
-You can pass a string value in the form of `=`.
-
-
-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 `=`.
-
-
-For example:
-
-
-```bash
-curl "http://localhost:9000/store/products?offset=1"
-```
-
-
-### Boolean
-
-
-You can pass a boolean value in the form of `=`.
-
-
-For example:
-
-
-```bash
-curl "http://localhost:9000/store/products?is_giftcard=true"
-```
-
-
-### Date and DateTime
-
-
-You can pass a date value in the form `=`. 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
-`[]=`. You can also specify the index of each
-parameter in the brackets `[0]=`.
-
-
-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
-`[]=`.
-
-
-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 API Routes, 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
-API Route:
-
-
-
-
- ```bash
- curl "http://localhost:9000/store/products?limit=5"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- limit: 5
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- limit: 5
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-### Response Fields
-
-
-In the response of listing API Routes, aside from the entities retrieved,
-there are three pagination-related fields returned:
-
-
-- `limit`: the maximum number of items that can be returned in the response.
-- `offset`: the number of items that were skipped before the entities in the result.
-- `count`: 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 API Routes 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/store/products?order=created_at"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- order: "created_at"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- order: "created_at"
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-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/store/products?order=-created_at"
- ```
-
-
-
-
- ```ts
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list({
- order: "-created_at"
- })
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- });
- ```
-
-
-
-
- ```tsx
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts({
- order: "-created_at"
- })
-
- return (
-
- {/* ... */}
-
- )
- }
-
- export default Products
- ```
-
-
-
-
-
-This sorts the products by their `created_at` attribute in the descending
-order.
-
-
-
-
\ No newline at end of file
diff --git a/www/apps/api-reference/app/api/[area]/page.tsx b/www/apps/api-reference/app/api/[area]/page.tsx
index d8dba1ece4..428ab2ace2 100644
--- a/www/apps/api-reference/app/api/[area]/page.tsx
+++ b/www/apps/api-reference/app/api/[area]/page.tsx
@@ -1,14 +1,13 @@
import AreaProvider from "@/providers/area"
-import AdminContentV1 from "../../_mdx/v1/admin.mdx"
-import StoreContentV1 from "../../_mdx/v1/store.mdx"
-import ClientLibrariesV1 from "../../_mdx/v1/client-libraries.mdx"
+import AdminContentV2 from "../../_mdx/admin.mdx"
+import StoreContentV2 from "../../_mdx/store.mdx"
+import ClientLibrariesV2 from "../../_mdx/client-libraries.mdx"
import Section from "@/components/Section"
import Tags from "@/components/Tags"
import type { Area } from "@/types/openapi"
import DividedLayout from "@/layouts/Divided"
import { capitalize } from "docs-ui"
-import PageTitleProvider from "../../../providers/page-title"
-import PageHeading from "../../../components/PageHeading"
+import PageTitleProvider from "@/providers/page-title"
type ReferencePageProps = {
params: {
@@ -20,16 +19,20 @@ const ReferencePage = async ({ params: { area } }: ReferencePageProps) => {
return (
-
+
- )
-}
-
-export default VariantInventory
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Address.yaml b/www/apps/api-reference/specs/admin/components/schemas/Address.yaml
deleted file mode 100644
index e0aee13932..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Address.yaml
+++ /dev/null
@@ -1,119 +0,0 @@
-title: Address
-description: >-
- An address is used across the Medusa backend within other schemas and object
- types. For example, a customer's billing and shipping addresses both use the
- Address entity.
-type: object
-required:
- - address_1
- - address_2
- - city
- - company
- - country_code
- - created_at
- - customer_id
- - deleted_at
- - first_name
- - id
- - last_name
- - metadata
- - phone
- - postal_code
- - province
- - updated_at
-properties:
- id:
- type: string
- description: ID of the address
- example: addr_01G8ZC9VS1XVE149MGH2J7QSSH
- customer_id:
- description: ID of the customer this address belongs to
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: Available if the relation `customer` is expanded.
- nullable: true
- type: object
- company:
- description: Company name
- nullable: true
- type: string
- example: Acme
- first_name:
- description: First name
- nullable: true
- type: string
- example: Arno
- last_name:
- description: Last name
- nullable: true
- type: string
- example: Willms
- address_1:
- description: Address line 1
- nullable: true
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- nullable: true
- type: string
- example: Suite 369
- city:
- description: City
- nullable: true
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- nullable: true
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- country:
- description: A country object.
- x-expandable: country
- nullable: true
- $ref: ./Country.yaml
- province:
- description: Province
- nullable: true
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- nullable: true
- type: string
- example: 72093
- phone:
- description: Phone Number
- nullable: true
- type: string
- example: 16128234334802
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AddressCreatePayload.yaml b/www/apps/api-reference/specs/admin/components/schemas/AddressCreatePayload.yaml
deleted file mode 100644
index 1094c0f176..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AddressCreatePayload.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-type: object
-description: Address fields used when creating an address.
-required:
- - first_name
- - last_name
- - address_1
- - city
- - country_code
- - postal_code
-properties:
- first_name:
- description: First name
- type: string
- example: Arno
- last_name:
- description: Last name
- type: string
- example: Willms
- phone:
- type: string
- description: Phone Number
- example: 16128234334802
- company:
- type: string
- address_1:
- description: Address line 1
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- type: string
- example: Suite 369
- city:
- description: City
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- province:
- description: Province
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- type: string
- example: 72093
- metadata:
- type: object
- example:
- car: white
- description: An optional key-value map with additional details
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml b/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml
deleted file mode 100644
index 826bf11526..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AddressPayload.yaml
+++ /dev/null
@@ -1,51 +0,0 @@
-type: object
-description: Address fields used when creating/updating an address.
-properties:
- first_name:
- description: First name
- type: string
- example: Arno
- last_name:
- description: Last name
- type: string
- example: Willms
- phone:
- type: string
- description: Phone Number
- example: 16128234334802
- company:
- type: string
- description: Company
- address_1:
- description: Address line 1
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- type: string
- example: Suite 369
- city:
- description: City
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- province:
- description: Province
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- type: string
- example: 72093
- metadata:
- type: object
- example:
- car: white
- description: An optional key-value map with additional details
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAppsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAppsListRes.yaml
deleted file mode 100644
index 8e153ad3a1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminAppsListRes.yaml
+++ /dev/null
@@ -1,9 +0,0 @@
-type: object
-required:
- - apps
-properties:
- apps:
- type: array
- description: An array of app details.
- items:
- $ref: ./OAuth.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAppsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAppsRes.yaml
deleted file mode 100644
index 8fa25e62de..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminAppsRes.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - apps
-properties:
- apps:
- description: App details.
- $ref: ./OAuth.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml
deleted file mode 100644
index a5f5bcc495..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminAuthRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The user's details.
-required:
- - user
-properties:
- user:
- description: User details.
- $ref: ./User.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobListRes.yaml
deleted file mode 100644
index 52fece9150..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobListRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - batch_jobs
- - count
- - offset
- - limit
-properties:
- batch_jobs:
- type: array
- description: An array of batch job details.
- items:
- $ref: ./BatchJob.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of batch jobs skipped when retrieving the batch jobs.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml
deleted file mode 100644
index 38e6af340d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminBatchJobRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The batch job's details.
-required:
- - batch_job
-properties:
- batch_job:
- description: Batch job details.
- $ref: ./BatchJob.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml
deleted file mode 100644
index cef364431b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminBearerAuthRes.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-type: object
-description: The access token of the user, if they're authenticated successfully.
-properties:
- access_token:
- description: Access token that can be used to send authenticated requests.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsDeleteRes.yaml
deleted file mode 100644
index d739f50061..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Collection
- object:
- type: string
- description: The type of the object that was deleted.
- default: product-collection
- deleted:
- type: boolean
- description: Whether the collection was deleted successfully or not.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsListRes.yaml
deleted file mode 100644
index 9a61e4fa9c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsListRes.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-type: object
-required:
- - collections
- - count
- - offset
- - limit
-properties:
- collections:
- type: array
- description: an array of collection details
- items:
- $ref: ./ProductCollection.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of product collections skipped when retrieving the product
- collections.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml
deleted file mode 100644
index c68818ac13..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCollectionsRes.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-description: The collection's details.
-x-expanded-relations:
- field: collection
- relations:
- - products
-required:
- - collection
-properties:
- collection:
- description: Product Collection details.
- $ref: ./ProductCollection.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateUserRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateUserRequest.yaml
deleted file mode 100644
index df3db57b09..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateUserRequest.yaml
+++ /dev/null
@@ -1,28 +0,0 @@
-type: object
-required:
- - email
- - password
-properties:
- email:
- description: The User's email.
- type: string
- format: email
- first_name:
- description: The first name of the User.
- type: string
- last_name:
- description: The last name of the User.
- type: string
- role:
- description: >-
- The role assigned to the user. These roles don't provide any different
- privileges.
- type: string
- enum:
- - admin
- - member
- - developer
- password:
- description: The User's password.
- type: string
- format: password
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml
deleted file mode 100644
index baf22c8547..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: List of currencies with pagination fields.
-required:
- - currencies
- - count
- - offset
- - limit
-properties:
- currencies:
- type: array
- description: An array of currency details.
- items:
- $ref: ./Currency.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of currencies skipped when retrieving the currencies.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml
deleted file mode 100644
index 6d75dfa3ac..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrenciesRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: A currency's details.
-required:
- - currency
-properties:
- currency:
- description: Currency details.
- $ref: ./Currency.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml
deleted file mode 100644
index c71ac29d49..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted customer group.
- object:
- type: string
- description: The type of the object that was deleted.
- default: customer_group
- deleted:
- type: boolean
- description: Whether the customer group was deleted successfully or not.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsListRes.yaml
deleted file mode 100644
index c776bf16a7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsListRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - customer_groups
- - count
- - offset
- - limit
-properties:
- customer_groups:
- type: array
- description: An array of customer group details.
- items:
- $ref: ./CustomerGroup.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of customer groups skipped when retrieving the customer groups.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml
deleted file mode 100644
index 738a35695c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The customer group's details.
-required:
- - customer_group
-properties:
- customer_group:
- description: Customer group details.
- $ref: ./CustomerGroup.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml
deleted file mode 100644
index bd60809bb7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-description: The list of customers with pagination fields.
-type: object
-required:
- - customers
- - count
- - offset
- - limit
-properties:
- customers:
- type: array
- description: An array of customer details.
- items:
- $ref: ./Customer.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of customers skipped when retrieving the customers.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml
deleted file mode 100644
index 47890d9d0b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomersRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The customer's details.
-x-expanded-relations:
- field: customer
- relations:
- - orders
- - shipping_addresses
-required:
- - customer
-properties:
- customer:
- description: Customer details.
- $ref: ./Customer.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml
deleted file mode 100644
index ebd0cf5526..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteCustomerGroupsGroupCustomerBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The customers to remove from the customer group.
-required:
- - customer_ids
-properties:
- customer_ids:
- description: The ids of the customers to remove
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: ID of the customer
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml
deleted file mode 100644
index 8e3b48b994..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteDiscountsDiscountConditionsConditionBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The resources to remove.
-required:
- - resources
-properties:
- resources:
- description: The resources to be removed from the discount condition
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The id of the item
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml
deleted file mode 100644
index 9bc07263fc..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListPricesPricesReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the prices to delete.
-properties:
- price_ids:
- description: The IDs of the prices to delete.
- type: array
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml
deleted file mode 100644
index b54e2e550f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePriceListsPriceListProductsPricesBatchReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the products' prices to delete.
-properties:
- product_ids:
- description: The IDs of the products to delete their associated prices.
- type: array
- items:
- type: string
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml
deleted file mode 100644
index 67764d4914..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductCategoriesCategoryProductsBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the products to delete from the product category.
-required:
- - product_ids
-properties:
- product_ids:
- description: The IDs of the products to delete from the product category.
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of a product
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml
deleted file mode 100644
index 2c9d19ccb5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionReq.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-description: The details of the products to remove from the collection.
-required:
- - product_ids
-properties:
- product_ids:
- description: An array of Product IDs to remove from the Product Collection.
- type: array
- items:
- description: The ID of a Product to add to the Product Collection.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml
deleted file mode 100644
index d387516c83..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteProductsFromCollectionRes.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-type: object
-description: Deletion operation details
-required:
- - id
- - object
- - removed_products
-properties:
- id:
- type: string
- description: The ID of the collection
- object:
- type: string
- description: The type of object the removal was executed on
- default: product-collection
- removed_products:
- description: The IDs of the products removed from the collection
- type: array
- items:
- description: The ID of the Product removed from the Product Collection.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml
deleted file mode 100644
index 3c1afa930c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeletePublishableApiKeySalesChannelsBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the sales channels to remove from the publishable API key.
-required:
- - sales_channel_ids
-properties:
- sales_channel_ids:
- description: The IDs of the sales channels to remove from the publishable API key
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- type: string
- description: The ID of the sales channel
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml
deleted file mode 100644
index 38602e26b4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelProductsBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the products to delete from the sales channel.
-required:
- - product_ids
-properties:
- product_ids:
- description: The IDs of the products to remove from the sales channel.
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of a product
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml
deleted file mode 100644
index a62aecc7e0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteSalesChannelsChannelStockLocationsReq.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - location_id
-properties:
- location_id:
- description: The ID of the stock location
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteShippingProfileRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteShippingProfileRes.yaml
deleted file mode 100644
index 05b2d2c485..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteShippingProfileRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Shipping Profile.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping_profile
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml
deleted file mode 100644
index 0323995581..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductTypesReq.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-description: Product types to remove from the tax rates.
-required:
- - product_types
-properties:
- product_types:
- type: array
- description: >-
- The IDs of the product types to remove their association with this tax
- rate.
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml
deleted file mode 100644
index 3e8e2efb14..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateProductsReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the products to remove their associated with the tax rate.
-required:
- - products
-properties:
- products:
- type: array
- description: The IDs of the products to remove their association with this tax rate.
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml
deleted file mode 100644
index e383613f0b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteTaxRatesTaxRateShippingOptionsReq.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: >-
- The details of the shipping options to remove their associate with the tax
- rate.
-required:
- - shipping_options
-properties:
- shipping_options:
- type: array
- description: >-
- The IDs of the shipping options to remove their association with this tax
- rate.
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml
deleted file mode 100644
index 28df01fe62..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the file to delete.
-required:
- - file_key
-properties:
- file_key:
- description: >-
- key of the file to delete. This is obtained when you first uploaded the
- file, or by the file service if you used it directly.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsRes.yaml
deleted file mode 100644
index 36c221a599..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUploadsRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The file key of the upload deleted
- object:
- type: string
- description: The type of the object that was deleted.
- default: file
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUserRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUserRes.yaml
deleted file mode 100644
index 1a0f1e1b90..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDeleteUserRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted user.
- object:
- type: string
- description: The type of the object that was deleted.
- default: user
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml
deleted file mode 100644
index f6fd7e7001..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountConditionsDeleteRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
- - discount
-properties:
- id:
- type: string
- description: The ID of the deleted Discount Condition
- object:
- type: string
- description: The type of the object that was deleted.
- default: discount-condition
- deleted:
- type: boolean
- description: Whether the discount condition was deleted successfully.
- default: true
- discount:
- description: The Discount to which the condition used to belong to.
- $ref: ./Discount.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountConditionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountConditionsRes.yaml
deleted file mode 100644
index 1afadae4db..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountConditionsRes.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-x-expanded-relations:
- field: discount_condition
- relations:
- - discount_rule
-required:
- - discount_condition
-properties:
- discount_condition:
- description: Discount condition details.
- $ref: ./DiscountCondition.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsDeleteRes.yaml
deleted file mode 100644
index d8db1a7a73..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Discount
- object:
- type: string
- description: The type of the object that was deleted.
- default: discount
- deleted:
- type: boolean
- description: Whether the discount was deleted successfully.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml
deleted file mode 100644
index 5f027be6e1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsListRes.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-type: object
-description: The list of discounts with pagination fields.
-x-expanded-relations:
- field: discounts
- relations:
- - parent_discount
- - regions
- - rule
- - rule.conditions
-required:
- - discounts
- - count
- - offset
- - limit
-properties:
- discounts:
- type: array
- description: The list of discounts.
- items:
- $ref: ./Discount.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of discounts skipped when retrieving the discounts.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml
deleted file mode 100644
index 55c5640e03..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDiscountsRes.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The discount's details.
-x-expanded-relations:
- field: discount
- relations:
- - parent_discount
- - regions
- - rule
- - rule.conditions
- eager:
- - regions.fulfillment_providers
- - regions.payment_providers
-required:
- - discount
-properties:
- discount:
- description: Discount details.
- $ref: ./Discount.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml
deleted file mode 100644
index b92534f839..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Draft Order.
- object:
- type: string
- description: The type of the object that was deleted.
- default: draft-order
- deleted:
- type: boolean
- description: Whether the draft order was deleted successfully.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml
deleted file mode 100644
index 539b3e9204..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersListRes.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-description: The list of draft orders with pagination fields.
-type: object
-x-expanded-relations:
- field: draft_orders
- relations:
- - order
- - cart
- - cart.items
- - cart.items.adjustments
-required:
- - draft_orders
- - count
- - offset
- - limit
-properties:
- draft_orders:
- type: array
- description: An array of draft order's details.
- items:
- $ref: ./DraftOrder.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of draft orders skipped when retrieving the draft orders.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml
deleted file mode 100644
index 20ae557261..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminDraftOrdersRes.yaml
+++ /dev/null
@@ -1,67 +0,0 @@
-type: object
-description: The list of draft orders.
-x-expanded-relations:
- field: draft_order
- relations:
- - order
- - cart
- - cart.items
- - cart.items.adjustments
- - cart.billing_address
- - cart.customer
- - cart.discounts
- - cart.discounts.rule
- - cart.items
- - cart.items.adjustments
- - cart.payment
- - cart.payment_sessions
- - cart.region
- - cart.region.payment_providers
- - cart.shipping_address
- - cart.shipping_methods
- - cart.shipping_methods.shipping_option
- eager:
- - cart.region.fulfillment_providers
- - cart.region.payment_providers
- - cart.shipping_methods.shipping_option
- implicit:
- - cart.discounts
- - cart.discounts.rule
- - cart.gift_cards
- - cart.items
- - cart.items.adjustments
- - cart.items.tax_lines
- - cart.items.variant
- - cart.items.variant.product
- - cart.items.variant.product.profiles
- - cart.region
- - cart.region.tax_rates
- - cart.shipping_address
- - cart.shipping_methods
- - cart.shipping_methods.tax_lines
- totals:
- - cart.discount_total
- - cart.gift_card_tax_total
- - cart.gift_card_total
- - cart.item_tax_total
- - cart.refundable_amount
- - cart.refunded_total
- - cart.shipping_tax_total
- - cart.shipping_total
- - cart.subtotal
- - cart.tax_total
- - cart.total
- - cart.items.discount_total
- - cart.items.gift_card_total
- - cart.items.original_tax_total
- - cart.items.original_total
- - cart.items.refundable
- - cart.items.subtotal
- - cart.items.tax_total
- - cart.items.total
-required:
- - draft_order
-properties:
- draft_order:
- description: Draft order's details.
- $ref: ./DraftOrder.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml
deleted file mode 100644
index b48265c097..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminExtendedStoresRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The store's details with additional details like payment and tax providers.
-x-expanded-relations:
- field: store
- relations:
- - currencies
- - default_currency
-required:
- - store
-properties:
- store:
- description: Store details.
- $ref: ./ExtendedStoreDTO.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesParams.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetProductsParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetProductsParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetProductsParams.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminGetProductsParams.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetPromotionsParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetPromotionsParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminGetPromotionsParams.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminGetPromotionsParams.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml
deleted file mode 100644
index 122df7072d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetRegionsRegionFulfillmentOptionsRes.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-type: object
-description: The list of fulfillment options in a region.
-required:
- - fulfillment_options
-properties:
- fulfillment_options:
- type: array
- description: Fulfillment providers details.
- items:
- type: object
- required:
- - provider_id
- - options
- properties:
- provider_id:
- description: ID of the fulfillment provider
- type: string
- options:
- description: fulfillment provider options
- type: array
- items:
- type: object
- example:
- - id: manual-fulfillment
- - id: manual-fulfillment-return
- is_return: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml
deleted file mode 100644
index fa021b68fd..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminGetVariantsVariantInventoryRes.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-description: The variant's inventory details.
-properties:
- variant:
- type: object
- description: The product variant's inventory details.
- $ref: ./VariantInventory.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsDeleteRes.yaml
deleted file mode 100644
index 2c6792ccee..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Gift Card
- object:
- type: string
- description: The type of the object that was deleted.
- default: gift-card
- deleted:
- type: boolean
- description: Whether the gift card was deleted successfully.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml
deleted file mode 100644
index 4554a7f3f7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsListRes.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
-type: object
-description: The list of gift cards with pagination fields.
-x-expanded-relations:
- field: gift_cards
- relations:
- - order
- - region
- eager:
- - region.fulfillment_providers
- - region.payment_providers
-required:
- - gift_cards
- - count
- - offset
- - limit
-properties:
- gift_cards:
- type: array
- description: The list of gift cards.
- items:
- $ref: ./GiftCard.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of gift cards skipped when retrieving the gift cards.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml
deleted file mode 100644
index 6660bb4615..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminGiftCardsRes.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The gift card's details.
-x-expanded-relations:
- field: gift_card
- relations:
- - order
- - region
- eager:
- - region.fulfillment_providers
- - region.payment_providers
-required:
- - gift_card
-properties:
- gift_card:
- description: A gift card's details.
- $ref: ./GiftCard.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsDeleteRes.yaml
deleted file mode 100644
index a0ded8e57a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Inventory Item.
- object:
- type: string
- description: The type of the object that was deleted.
- format: inventory_item
- deleted:
- type: boolean
- description: Whether or not the Inventory Item was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsListRes.yaml
deleted file mode 100644
index facac5fb99..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsListRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - inventory_items
- - count
- - offset
- - limit
-properties:
- inventory_items:
- type: array
- description: an array of Inventory Item details
- items:
- $ref: ./InventoryItemDTO.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of inventory items skipped when retrieving the inventory items.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.yaml
deleted file mode 100644
index 0a8a0fcd33..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsListWithVariantsAndLocationLevelsRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - inventory_items
- - count
- - offset
- - limit
-properties:
- inventory_items:
- type: array
- description: an array of Inventory Item details
- items:
- $ref: ./DecoratedInventoryItemDTO.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of inventory items skipped when retrieving the inventory items.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml
deleted file mode 100644
index 2eae35229b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsLocationLevelsRes.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-type: object
-description: Details of inventory items and their associated location levels.
-required:
- - inventory_item
-properties:
- inventory_item:
- type: object
- description: An inventory item's ID and associated location levels.
- required:
- - id
- - location_levels
- properties:
- id:
- description: The id of the location
- type: string
- location_levels:
- description: List of stock levels at a given location
- type: array
- items:
- $ref: ./InventoryLevelDTO.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml
deleted file mode 100644
index 5970f5ad2f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItemsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The inventory item's details.
-required:
- - inventory_item
-properties:
- inventory_item:
- description: Inventory Item details
- $ref: ./InventoryItemDTO.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInviteDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInviteDeleteRes.yaml
deleted file mode 100644
index c1a8947cd4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminInviteDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Invite.
- object:
- type: string
- description: The type of the object that was deleted.
- default: invite
- deleted:
- type: boolean
- description: Whether or not the invite was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml
deleted file mode 100644
index 24604800af..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminListInvitesRes.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-description: The list of invites.
-type: object
-required:
- - invites
-properties:
- invites:
- type: array
- description: An array of invites
- items:
- $ref: ./Invite.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesDeleteRes.yaml
deleted file mode 100644
index 679ce92ba8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Note.
- object:
- type: string
- description: The type of the object that was deleted.
- default: note
- deleted:
- type: boolean
- description: Whether or not the Note was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml
deleted file mode 100644
index a65b53deaf..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of notes with pagination fields.
-required:
- - notes
- - count
- - offset
- - limit
-properties:
- notes:
- type: array
- description: An array of notes
- items:
- $ref: ./Note.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of notes skipped when retrieving the notes.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml
deleted file mode 100644
index cb19ac88c4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotesRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The note's details.
-required:
- - note
-properties:
- note:
- description: Note details.
- $ref: ./Note.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsListRes.yaml
deleted file mode 100644
index 1cc05a0a14..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-x-expanded-relations:
- field: notifications
- relations:
- - resends
-required:
- - notifications
-properties:
- notifications:
- type: array
- description: an array of notifications
- items:
- $ref: ./Notification.yaml
- count:
- type: integer
- description: The total number of notifications
- offset:
- type: integer
- description: The number of notifications skipped when retrieving the notifications.
- limit:
- type: integer
- description: The number of notifications per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml
deleted file mode 100644
index 72d8cd2f2a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminNotificationsRes.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-description: The notification's details.
-x-expanded-relations:
- field: notification
- relations:
- - resends
-required:
- - notification
-properties:
- notification:
- description: Notification details
- $ref: ./Notification.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditDeleteRes.yaml
deleted file mode 100644
index 2435bc0769..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Order Edit.
- object:
- type: string
- description: The type of the object that was deleted.
- default: order_edit
- deleted:
- type: boolean
- description: Whether or not the Order Edit was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml
deleted file mode 100644
index 3004c5cfd9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditItemChangeDeleteRes.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The details of deleting order edit item changes.
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Order Edit Item Change.
- object:
- type: string
- description: The type of the object that was deleted.
- default: item_change
- deleted:
- type: boolean
- description: Whether or not the Order Edit Item Change was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml
deleted file mode 100644
index a49569c577..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsListRes.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-type: object
-description: The list of order edits with pagination fields.
-x-expanded-relations:
- field: order_edits
- relations:
- - changes
- - changes.line_item
- - changes.line_item.variant
- - changes.original_line_item
- - changes.original_line_item.variant
- - items
- - items.adjustments
- - items.tax_lines
- - items.variant
- - payment_collection
- implicit:
- - items
- - items.tax_lines
- - items.adjustments
- - items.variant
- totals:
- - difference_due
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
-required:
- - order_edits
- - count
- - offset
- - limit
-properties:
- order_edits:
- type: array
- description: An array of order edit details
- items:
- $ref: ./OrderEdit.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of order edits skipped when retrieving the order edits.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml
deleted file mode 100644
index 77f7749b24..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditsRes.yaml
+++ /dev/null
@@ -1,43 +0,0 @@
-type: object
-description: The order edit details.
-x-expanded-relations:
- field: order_edit
- relations:
- - changes
- - changes.line_item
- - changes.line_item.variant
- - changes.original_line_item
- - changes.original_line_item.variant
- - items
- - items.adjustments
- - items.tax_lines
- - items.variant
- - payment_collection
- implicit:
- - items
- - items.tax_lines
- - items.adjustments
- - items.variant
- totals:
- - difference_due
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
-required:
- - order_edit
-properties:
- order_edit:
- description: Order edit details
- $ref: ./OrderEdit.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml
deleted file mode 100644
index 05b64d5f94..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersListRes.yaml
+++ /dev/null
@@ -1,126 +0,0 @@
-type: object
-description: The list of orders with pagination fields.
-x-expanded-relations:
- field: orders
- relations:
- - billing_address
- - claims
- - claims.additional_items
- - claims.additional_items.variant
- - claims.claim_items
- - claims.claim_items.images
- - claims.claim_items.item
- - claims.fulfillments
- - claims.fulfillments.tracking_links
- - claims.return_order
- - claims.return_order.shipping_method
- - claims.return_order.shipping_method.tax_lines
- - claims.shipping_address
- - claims.shipping_methods
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.items
- - fulfillments.tracking_links
- - gift_card_transactions
- - gift_cards
- - items
- - payments
- - refunds
- - region
- - returns
- - returns.items
- - returns.items.reason
- - returns.shipping_method
- - returns.shipping_method.tax_lines
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
- - region.fulfillment_providers
- - region.payment_providers
- - returns.items
- - shipping_methods.shipping_option
- implicit:
- - claims
- - claims.additional_items
- - claims.additional_items.adjustments
- - claims.additional_items.refundable
- - claims.additional_items.tax_lines
- - discounts
- - discounts.rule
- - gift_card_transactions
- - gift_card_transactions.gift_card
- - gift_cards
- - items
- - items.adjustments
- - items.refundable
- - items.tax_lines
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - refunds
- - region
- - shipping_methods
- - shipping_methods.tax_lines
- - swaps
- - swaps.additional_items
- - swaps.additional_items.adjustments
- - swaps.additional_items.refundable
- - swaps.additional_items.tax_lines
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - paid_total
- - refundable_amount
- - refunded_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - claims.additional_items.discount_total
- - claims.additional_items.gift_card_total
- - claims.additional_items.original_tax_total
- - claims.additional_items.original_total
- - claims.additional_items.refundable
- - claims.additional_items.subtotal
- - claims.additional_items.tax_total
- - claims.additional_items.total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- - swaps.additional_items.discount_total
- - swaps.additional_items.gift_card_total
- - swaps.additional_items.original_tax_total
- - swaps.additional_items.original_total
- - swaps.additional_items.refundable
- - swaps.additional_items.subtotal
- - swaps.additional_items.tax_total
- - swaps.additional_items.total
-required:
- - orders
- - count
- - offset
- - limit
-properties:
- orders:
- type: array
- description: An array of order details.
- items:
- $ref: ./Order.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of orders skipped when retrieving the orders.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
deleted file mode 100644
index c8713b6be9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersOrderLineItemReservationReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-required:
- - location_id
-properties:
- location_id:
- description: The ID of the location of the reservation
- type: string
- quantity:
- description: The quantity to reserve
- type: number
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml
deleted file mode 100644
index 15f2179e17..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrdersRes.yaml
+++ /dev/null
@@ -1,112 +0,0 @@
-type: object
-description: The order's details.
-x-expanded-relations:
- field: order
- relations:
- - billing_address
- - claims
- - claims.additional_items
- - claims.additional_items.variant
- - claims.claim_items
- - claims.claim_items.images
- - claims.claim_items.item
- - claims.fulfillments
- - claims.fulfillments.tracking_links
- - claims.return_order
- - claims.return_order.shipping_method
- - claims.return_order.shipping_method.tax_lines
- - claims.shipping_address
- - claims.shipping_methods
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.items
- - fulfillments.tracking_links
- - gift_card_transactions
- - gift_cards
- - items
- - payments
- - refunds
- - region
- - returns
- - returns.items
- - returns.items.reason
- - returns.shipping_method
- - returns.shipping_method.tax_lines
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
- - region.fulfillment_providers
- - region.payment_providers
- - returns.items
- - shipping_methods.shipping_option
- implicit:
- - claims
- - claims.additional_items
- - claims.additional_items.adjustments
- - claims.additional_items.refundable
- - claims.additional_items.tax_lines
- - discounts
- - discounts.rule
- - gift_card_transactions
- - gift_card_transactions.gift_card
- - gift_cards
- - items
- - items.adjustments
- - items.refundable
- - items.tax_lines
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - refunds
- - region
- - shipping_methods
- - shipping_methods.tax_lines
- - swaps
- - swaps.additional_items
- - swaps.additional_items.adjustments
- - swaps.additional_items.refundable
- - swaps.additional_items.tax_lines
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - paid_total
- - refundable_amount
- - refunded_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - claims.additional_items.discount_total
- - claims.additional_items.gift_card_total
- - claims.additional_items.original_tax_total
- - claims.additional_items.original_total
- - claims.additional_items.refundable
- - claims.additional_items.subtotal
- - claims.additional_items.tax_total
- - claims.additional_items.total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- - swaps.additional_items.discount_total
- - swaps.additional_items.gift_card_total
- - swaps.additional_items.original_tax_total
- - swaps.additional_items.original_total
- - swaps.additional_items.refundable
- - swaps.additional_items.subtotal
- - swaps.additional_items.tax_total
- - swaps.additional_items.total
-required:
- - order
-properties:
- order:
- description: Order details.
- $ref: ./Order.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml
deleted file mode 100644
index a2a7150b53..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionDeleteRes.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The details of deleting a payment collection.
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Payment Collection.
- object:
- type: string
- description: The type of the object that was deleted.
- default: payment_collection
- deleted:
- type: boolean
- description: Whether or not the Payment Collection was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml
deleted file mode 100644
index 690f1daeff..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollectionsRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The payment collection's details.
-x-expanded-relations:
- field: payment_collection
- relations:
- - payment_sessions
- - payments
- - region
- eager:
- - region.fulfillment_providers
- - region.payment_providers
-required:
- - payment_collection
-properties:
- payment_collection:
- description: Payment Collection details.
- $ref: ./PaymentCollection.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml
deleted file mode 100644
index d0548fb65d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentProvidersList.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The list of payment providers in a store.
-required:
- - payment_providers
-properties:
- payment_providers:
- type: array
- description: An array of payment providers details.
- items:
- $ref: ./PaymentProvider.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml
deleted file mode 100644
index 7d52b01d9a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The payment's details.
-required:
- - payment
-properties:
- payment:
- description: Payment details
- $ref: ./Payment.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostAppsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostAppsReq.yaml
deleted file mode 100644
index 62016f8b7b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostAppsReq.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-required:
- - application_name
- - state
- - code
-properties:
- application_name:
- type: string
- description: Name of the application for to generate the token for.
- state:
- type: string
- description: State of the application.
- code:
- type: string
- description: The code for the generated token.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml
deleted file mode 100644
index 49793b6181..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostAuthReq.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: The admin's credentials used to log in.
-required:
- - email
- - password
-properties:
- email:
- type: string
- description: The user's email.
- format: email
- password:
- type: string
- description: The user's password.
- format: password
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml
deleted file mode 100644
index 7219868bf1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostBatchesReq.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-type: object
-description: The details of the batch job to create.
-required:
- - type
- - context
-properties:
- type:
- type: string
- description: >-
- The type of batch job to start, which is defined by the `batchType`
- property of the associated batch job strategy.
- example: product-export
- context:
- type: object
- description: Additional infomration regarding the batch to be used for processing.
- example:
- shape:
- prices:
- - region: null
- currency_code: eur
- dynamicImageColumnCount: 4
- dynamicOptionColumnCount: 2
- list_config:
- skip: 0
- take: 50
- order:
- created_at: DESC
- relations:
- - variants
- - variant.prices
- - images
- dry_run:
- type: boolean
- description: >-
- Set a batch job in dry_run mode, which would delay executing the batch job
- until it's confirmed.
- default: false
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostCampaignsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCampaignsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostCampaignsReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostCampaignsReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml
deleted file mode 100644
index 2fd371ac5f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsCollectionReq.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The product collection's details to update.
-properties:
- title:
- type: string
- description: The title of the collection.
- handle:
- type: string
- description: >-
- An optional handle to be used in slugs. If none is provided, the
- kebab-case version of the title will be used.
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml
deleted file mode 100644
index 2b759bb8b8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCollectionsReq.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-type: object
-description: The product collection's details.
-required:
- - title
-properties:
- title:
- type: string
- description: The title of the collection.
- handle:
- type: string
- description: >-
- An optional handle to be used in slugs. If none is provided, the
- kebab-case version of the title will be used.
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml
deleted file mode 100644
index a18f97dea6..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCurrenciesCurrencyReq.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-description: The details to update in the currency
-properties:
- includes_tax:
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- description: Tax included in prices of currency.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
index 001be4ea41..b6d536cac5 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
@@ -1,16 +1,20 @@
type: object
-description: The customers to add to the customer group.
+description: SUMMARY
+x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq
required:
- customer_ids
properties:
customer_ids:
- description: The ids of the customers to add
type: array
+ description: The customer group's customer ids.
items:
type: object
+ description: The customer id's customer ids.
+ x-schemaName: CustomerGroupsBatchCustomer
required:
- id
properties:
id:
- description: ID of the customer
type: string
+ title: id
+ description: The customer id's ID.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml
deleted file mode 100644
index 073078c077..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsGroupReq.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The details to update in the customer group.
-properties:
- name:
- description: Name of the customer group
- type: string
- metadata:
- description: Metadata of the customer group.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml
deleted file mode 100644
index d28a86c9f6..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomerGroupsReq.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-description: The details of the customer group to create.
-required:
- - name
-properties:
- name:
- type: string
- description: Name of the customer group
- metadata:
- type: object
- description: Metadata of the customer group.
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml
deleted file mode 100644
index 4a5bf522e7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersCustomerReq.yaml
+++ /dev/null
@@ -1,38 +0,0 @@
-type: object
-description: The details of the customer to update.
-properties:
- email:
- type: string
- description: The Customer's email. You can't update the email of a registered customer.
- format: email
- first_name:
- type: string
- description: The Customer's first name.
- last_name:
- type: string
- description: The Customer's last name.
- phone:
- type: string
- description: The Customer's phone number.
- password:
- type: string
- description: The Customer's password.
- format: password
- groups:
- type: array
- description: A list of customer groups to which the customer belongs.
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of a customer group
- type: string
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml
deleted file mode 100644
index 724189f931..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostCustomersReq.yaml
+++ /dev/null
@@ -1,32 +0,0 @@
-type: object
-description: The details of the customer to create.
-required:
- - email
- - first_name
- - last_name
- - password
-properties:
- email:
- type: string
- description: The customer's email.
- format: email
- first_name:
- type: string
- description: The customer's first name.
- last_name:
- type: string
- description: The customer's last name.
- password:
- type: string
- description: The customer's password.
- format: password
- phone:
- type: string
- description: The customer's phone number.
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditions.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditions.yaml
deleted file mode 100644
index 767bd96f4c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditions.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-type: object
-required:
- - operator
-properties:
- operator:
- description: >-
- Operator of the condition. `in` indicates that discountable resources are
- within the specified resources. `not_in` indicates that discountable
- resources are everything but the specified resources.
- type: string
- enum:
- - in
- - not_in
- products:
- type: array
- description: list of product IDs if the condition's type is `products`.
- items:
- type: string
- product_types:
- type: array
- description: list of product type IDs if the condition's type is `product_types`.
- items:
- type: string
- product_collections:
- type: array
- description: >-
- list of product collection IDs if the condition's type is
- `product_collections`.
- items:
- type: string
- product_tags:
- type: array
- description: list of product tag IDs if the condition's type is `product_tags`.
- items:
- type: string
- customer_groups:
- type: array
- description: list of customer group IDs if the condition's type is `customer_groups`.
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsCondition.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsCondition.yaml
deleted file mode 100644
index 23b5daf95d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsCondition.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-type: object
-properties:
- products:
- type: array
- description: list of product IDs if the condition's type is `products`.
- items:
- type: string
- product_types:
- type: array
- description: list of product type IDs if the condition's type is `product_types`.
- items:
- type: string
- product_collections:
- type: array
- description: >-
- list of product collection IDs if the condition's type is
- `product_collections`.
- items:
- type: string
- product_tags:
- type: array
- description: list of product tag IDs if the condition's type is `product_tags`
- items:
- type: string
- customer_groups:
- type: array
- description: list of customer group IDs if the condition's type is `customer_groups`.
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml
deleted file mode 100644
index 592e04144d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountConditionsConditionBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the resources to add.
-required:
- - resources
-properties:
- resources:
- description: The resources to be added to the discount condition
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of the item
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml
deleted file mode 100644
index 9b8818aae8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountDynamicCodesReq.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-type: object
-description: The details of the dynamic discount to create.
-required:
- - code
-properties:
- code:
- type: string
- description: A unique code that will be used to redeem the Discount
- usage_limit:
- type: number
- description: Maximum number of times the discount code can be used
- default: 1
- metadata:
- type: object
- description: An optional set of key-value pairs to hold additional information.
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml
deleted file mode 100644
index 58fd553d1f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsDiscountReq.yaml
+++ /dev/null
@@ -1,125 +0,0 @@
-type: object
-description: The details of the discount to update.
-properties:
- code:
- type: string
- description: A unique code that will be used to redeem the discount
- rule:
- description: The discount rule that defines how discounts are calculated
- type: object
- required:
- - id
- properties:
- id:
- type: string
- description: The ID of the Rule
- description:
- type: string
- description: A short description of the discount
- value:
- type: number
- description: >-
- The value that the discount represents. This will depend on the type
- of the discount.
- allocation:
- type: string
- description: >-
- The scope that the discount should apply to. `total` indicates that
- the discount should be applied on the cart total, and `item` indicates
- that the discount should be applied to each discountable item in the
- cart.
- enum:
- - total
- - item
- conditions:
- type: array
- description: >-
- A set of conditions that can be used to limit when the discount can be
- used. Only one of `products`, `product_types`, `product_collections`,
- `product_tags`, and `customer_groups` should be provided based on the
- discount condition's type.
- items:
- type: object
- required:
- - operator
- properties:
- id:
- type: string
- description: The ID of the condition
- operator:
- type: string
- description: >-
- Operator of the condition. `in` indicates that discountable
- resources are within the specified resources. `not_in` indicates
- that discountable resources are everything but the specified
- resources.
- enum:
- - in
- - not_in
- products:
- type: array
- description: list of product IDs if the condition's type is `products`.
- items:
- type: string
- product_types:
- type: array
- description: >-
- list of product type IDs if the condition's type is
- `product_types`.
- items:
- type: string
- product_collections:
- type: array
- description: >-
- list of product collection IDs if the condition's type is
- `product_collections`.
- items:
- type: string
- product_tags:
- type: array
- description: >-
- list of product tag IDs if the condition's type is
- `product_tags`.
- items:
- type: string
- customer_groups:
- type: array
- description: >-
- list of customer group IDs if the condition's type is
- `customer_groups`.
- items:
- type: string
- is_disabled:
- type: boolean
- description: >-
- Whether the discount code is disabled on creation. If set to `true`, it
- will not be available for customers.
- starts_at:
- type: string
- format: date-time
- description: The date and time at which the discount should be available.
- ends_at:
- type: string
- format: date-time
- description: The date and time at which the discount should no longer be available.
- valid_duration:
- type: string
- description: The duration the discount runs between
- example: P3Y6M4DT12H30M5S
- usage_limit:
- type: number
- description: Maximum number of times the discount can be used
- regions:
- description: >-
- A list of region IDs representing the Regions in which the Discount can be
- used.
- type: array
- items:
- type: string
- metadata:
- description: An object containing metadata of the discount
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml
deleted file mode 100644
index 4aca231f7e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDiscountsReq.yaml
+++ /dev/null
@@ -1,143 +0,0 @@
-type: object
-description: The details of the discount to create.
-required:
- - code
- - rule
- - regions
-properties:
- code:
- type: string
- description: A unique code that will be used to redeem the discount
- is_dynamic:
- type: boolean
- description: >-
- Whether the discount should have multiple instances of itself, each with a
- different code. This can be useful for automatically generated discount
- codes that all have to follow a common set of rules.
- default: false
- rule:
- description: The discount rule that defines how discounts are calculated
- type: object
- required:
- - type
- - value
- - allocation
- properties:
- description:
- type: string
- description: A short description of the discount
- type:
- type: string
- description: >-
- The type of the discount, can be `fixed` for discounts that reduce the
- price by a fixed amount, `percentage` for percentage reductions or
- `free_shipping` for shipping vouchers.
- enum:
- - fixed
- - percentage
- - free_shipping
- value:
- type: number
- description: >-
- The value that the discount represents. This will depend on the type
- of the discount.
- allocation:
- type: string
- description: >-
- The scope that the discount should apply to. `total` indicates that
- the discount should be applied on the cart total, and `item` indicates
- that the discount should be applied to each discountable item in the
- cart.
- enum:
- - total
- - item
- conditions:
- type: array
- description: >-
- A set of conditions that can be used to limit when the discount can be
- used. Only one of `products`, `product_types`, `product_collections`,
- `product_tags`, and `customer_groups` should be provided based on the
- discount condition's type.
- items:
- type: object
- required:
- - operator
- properties:
- operator:
- type: string
- description: >-
- Operator of the condition. `in` indicates that discountable
- resources are within the specified resources. `not_in` indicates
- that discountable resources are everything but the specified
- resources.
- enum:
- - in
- - not_in
- products:
- type: array
- description: list of product IDs if the condition's type is `products`.
- items:
- type: string
- product_types:
- type: array
- description: >-
- list of product type IDs if the condition's type is
- `product_types`.
- items:
- type: string
- product_collections:
- type: array
- description: >-
- list of product collection IDs if the condition's type is
- `product_collections`.
- items:
- type: string
- product_tags:
- type: array
- description: >-
- list of product tag IDs if the condition's type is
- `product_tags`.
- items:
- type: string
- customer_groups:
- type: array
- description: >-
- list of customer group IDs if the condition's type is
- `customer_groups`.
- items:
- type: string
- is_disabled:
- type: boolean
- description: >-
- Whether the discount code is disabled on creation. If set to `true`, it
- will not be available for customers.
- default: false
- starts_at:
- type: string
- format: date-time
- description: The date and time at which the discount should be available.
- ends_at:
- type: string
- format: date-time
- description: The date and time at which the discount should no longer be available.
- valid_duration:
- type: string
- description: The duration the discount runs between
- example: P3Y6M4DT12H30M5S
- regions:
- description: >-
- A list of region IDs representing the Regions in which the Discount can be
- used.
- type: array
- items:
- type: string
- usage_limit:
- type: number
- description: Maximum number of times the discount can be used
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml
deleted file mode 100644
index 9eb17a0a8a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsItemReq.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-description: The details to update of the line item.
-properties:
- unit_price:
- description: >-
- The custom price of the line item. If a `variant_id` is supplied, the
- price provided here will override the variant's price.
- type: integer
- title:
- description: The title of the line item if `variant_id` is not provided.
- type: string
- quantity:
- description: The quantity of the line item.
- type: integer
- metadata:
- description: The optional key-value map with additional details about the Line Item.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml
deleted file mode 100644
index eb259a08f5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderLineItemsReq.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-type: object
-description: The details of the line item to create.
-required:
- - quantity
-properties:
- variant_id:
- description: >-
- The ID of the Product Variant associated with the line item. If the line
- item is custom, the `variant_id` should be omitted.
- type: string
- unit_price:
- description: >-
- The custom price of the line item. If a `variant_id` is supplied, the
- price provided here will override the variant's price.
- type: integer
- title:
- description: The title of the line item if `variant_id` is not provided.
- type: string
- default: Custom item
- quantity:
- description: The quantity of the line item.
- type: integer
- metadata:
- description: The optional key-value map with additional details about the Line Item.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml
deleted file mode 100644
index 949163a867..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderRegisterPaymentRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The order's details.
-required:
- - order
-properties:
- order:
- description: Order's details.
- $ref: ./Order.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml
deleted file mode 100644
index 48ac5e452f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersDraftOrderReq.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-type: object
-description: The details of the draft order to update.
-properties:
- region_id:
- type: string
- description: The ID of the Region to create the Draft Order in.
- country_code:
- type: string
- description: The 2 character ISO code for the Country.
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- email:
- type: string
- description: An email to be used in the Draft Order.
- format: email
- billing_address:
- description: The Address to be used for billing purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- - type: string
- shipping_address:
- description: The Address to be used for shipping purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- - type: string
- discounts:
- description: An array of Discount codes to add to the Draft Order.
- type: array
- items:
- type: object
- required:
- - code
- properties:
- code:
- description: The code that a Discount is identifed by.
- type: string
- no_notification_order:
- description: >-
- An optional flag passed to the resulting order that indicates whether the
- customer should receive notifications about order updates.
- type: boolean
- customer_id:
- description: The ID of the customer this draft order is associated with.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml
deleted file mode 100644
index a3e5578924..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostDraftOrdersReq.yaml
+++ /dev/null
@@ -1,110 +0,0 @@
-type: object
-description: The details of the draft order to create.
-required:
- - email
- - region_id
- - shipping_methods
-properties:
- status:
- description: >-
- The status of the draft order. The draft order's default status is `open`.
- It's changed to `completed` when its payment is marked as paid.
- type: string
- enum:
- - open
- - completed
- email:
- description: The email of the customer of the draft order
- type: string
- format: email
- billing_address:
- description: The Address to be used for billing purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- - type: string
- shipping_address:
- description: The Address to be used for shipping purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- - type: string
- items:
- description: The draft order's line items.
- type: array
- items:
- type: object
- required:
- - quantity
- properties:
- variant_id:
- description: >-
- The ID of the Product Variant associated with the line item. If the
- line item is custom, the `variant_id` should be omitted.
- type: string
- unit_price:
- description: >-
- The custom price of the line item. If a `variant_id` is supplied,
- the price provided here will override the variant's price.
- type: integer
- title:
- description: The title of the line item if `variant_id` is not provided.
- type: string
- quantity:
- description: The quantity of the line item.
- type: integer
- metadata:
- description: >-
- The optional key-value map with additional details about the line
- item.
- type: object
- externalDocs:
- description: >-
- Learn about the metadata attribute, and how to delete and update
- it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- region_id:
- description: The ID of the region for the draft order
- type: string
- discounts:
- description: The discounts to add to the draft order
- type: array
- items:
- type: object
- required:
- - code
- properties:
- code:
- description: The code of the discount to apply
- type: string
- customer_id:
- description: The ID of the customer this draft order is associated with.
- type: string
- no_notification_order:
- description: >-
- An optional flag passed to the resulting order that indicates whether the
- customer should receive notifications about order updates.
- type: boolean
- shipping_methods:
- description: The shipping methods for the draft order
- type: array
- items:
- type: object
- required:
- - option_id
- properties:
- option_id:
- description: The ID of the shipping option in use
- type: string
- data:
- description: The optional additional data needed for the shipping method
- type: object
- price:
- description: The price of the shipping method.
- type: integer
- metadata:
- description: The optional key-value map with additional details about the Draft Order.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml
deleted file mode 100644
index fe097102c9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsGiftCardReq.yaml
+++ /dev/null
@@ -1,25 +0,0 @@
-type: object
-description: The details to update of the gift card.
-properties:
- balance:
- type: integer
- description: The value (excluding VAT) that the Gift Card should represent.
- is_disabled:
- type: boolean
- description: >-
- Whether the Gift Card is disabled on creation. If set to `true`, the gift
- card will not be available for customers.
- ends_at:
- type: string
- format: date-time
- description: The date and time at which the Gift Card should no longer be available.
- region_id:
- description: The ID of the Region in which the Gift Card can be used.
- type: string
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml
deleted file mode 100644
index 1704d9a3e2..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostGiftCardsReq.yaml
+++ /dev/null
@@ -1,27 +0,0 @@
-type: object
-description: The details of the gift card to create.
-required:
- - region_id
-properties:
- value:
- type: integer
- description: The value (excluding VAT) that the Gift Card should represent.
- is_disabled:
- type: boolean
- description: >-
- Whether the Gift Card is disabled on creation. If set to `true`, the gift
- card will not be available for customers.
- ends_at:
- type: string
- format: date-time
- description: The date and time at which the Gift Card should no longer be available.
- region_id:
- description: The ID of the Region in which the Gift Card can be used.
- type: string
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
index 5d28182435..bf0295b65b 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
@@ -1,57 +1,56 @@
type: object
-description: The attributes to update in an inventory item.
+description: SUMMARY
+x-schemaName: AdminPostInventoryItemsInventoryItemReq
properties:
- hs_code:
- description: >-
- The Harmonized System code of the Inventory Item. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
+ sku:
type: string
+ title: sku
+ description: The inventory item's sku.
origin_country:
- description: >-
- The country in which the Inventory Item was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
type: string
+ title: origin_country
+ description: The inventory item's origin country.
+ hs_code:
+ type: string
+ title: hs_code
+ description: The inventory item's hs code.
mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Inventory Item. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
type: string
+ title: mid_code
+ description: The inventory item's mid code.
material:
- description: >-
- The material and composition that the Inventory Item is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
type: string
+ title: material
+ description: The inventory item's material.
weight:
- description: >-
- The weight of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: weight
+ description: The inventory item's weight.
height:
- description: >-
- The height of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- width:
- description: >-
- The width of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: height
+ description: The inventory item's height.
length:
- description: >-
- The length of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: length
+ description: The inventory item's length.
+ width:
+ type: number
+ title: width
+ description: The inventory item's width.
title:
+ type: string
+ title: title
description: The inventory item's title.
- type: string
description:
+ type: string
+ title: description
description: The inventory item's description.
- type: string
thumbnail:
- description: The inventory item's thumbnail.
type: string
+ title: thumbnail
+ description: The inventory item's thumbnail.
requires_shipping:
- description: Whether the item requires shipping.
type: boolean
+ title: requires_shipping
+ description: The inventory item's requires shipping.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
index 27f8b44407..444b8870c0 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
@@ -1,8 +1,12 @@
type: object
+description: SUMMARY
+x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq
properties:
- stocked_quantity:
- description: the total stock quantity of an inventory item at the given location ID
- type: number
incoming_quantity:
- description: the incoming stock quantity of an inventory item at the given location ID
type: number
+ title: incoming_quantity
+ description: The inventory item's incoming quantity.
+ stocked_quantity:
+ type: number
+ title: stocked_quantity
+ description: The inventory item's stocked quantity.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
index c7c1dc67ba..0bdd7938fe 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
@@ -1,15 +1,19 @@
type: object
-description: The details of the location level to create.
+description: SUMMARY
+x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq
required:
- location_id
- stocked_quantity
properties:
location_id:
- description: the ID of the stock location
type: string
+ title: location_id
+ description: The inventory item's location id.
stocked_quantity:
- description: the stock quantity of the inventory item at this location
type: number
+ title: stocked_quantity
+ description: The inventory item's stocked quantity.
incoming_quantity:
- description: the incoming stock quantity of the inventory item at this location
type: number
+ title: incoming_quantity
+ description: The inventory item's incoming quantity.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml
index 1516b42d4a..d97997e360 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInventoryItemsReq.yaml
@@ -1,91 +1,56 @@
type: object
-description: The details of the inventory item to create.
-required:
- - variant_id
+description: SUMMARY
+x-schemaName: AdminPostInventoryItemsReq
properties:
- variant_id:
- description: The ID of the variant to create the inventory item for.
- type: string
sku:
- description: The unique SKU of the associated Product Variant.
- type: string
- ean:
- description: The EAN number of the item.
- type: string
- upc:
- description: The UPC number of the item.
- type: string
- barcode:
- description: A generic GTIN field for the Product Variant.
type: string
+ title: sku
+ description: The inventory item's sku.
hs_code:
- description: >-
- The Harmonized System code of the Inventory Item. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
type: string
- inventory_quantity:
- description: The amount of stock kept of the associated Product Variant.
- type: integer
- default: 0
- allow_backorder:
- description: Whether the associated Product Variant can be purchased when out of stock.
- type: boolean
- manage_inventory:
- description: >-
- Whether Medusa should keep track of the inventory for the associated
- Product Variant.
- type: boolean
- default: true
+ title: hs_code
+ description: The inventory item's hs code.
weight:
- description: >-
- The weight of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: weight
+ description: The inventory item's weight.
length:
- description: >-
- The length of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: length
+ description: The inventory item's length.
height:
- description: >-
- The height of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: height
+ description: The inventory item's height.
width:
- description: >-
- The width of the Inventory Item. May be used in shipping rate
- calculations.
type: number
+ title: width
+ description: The inventory item's width.
origin_country:
- description: >-
- The country in which the Inventory Item was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
type: string
+ title: origin_country
+ description: The inventory item's origin country.
mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Inventory Item. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
type: string
+ title: mid_code
+ description: The inventory item's mid code.
material:
- description: >-
- The material and composition that the Inventory Item is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
type: string
+ title: material
+ description: The inventory item's material.
title:
+ type: string
+ title: title
description: The inventory item's title.
- type: string
description:
+ type: string
+ title: description
description: The inventory item's description.
- type: string
thumbnail:
- description: The inventory item's thumbnail.
type: string
+ title: thumbnail
+ description: The inventory item's thumbnail.
metadata:
- description: An optional set of key-value pairs with additional information.
type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
+ description: The inventory item's metadata.
+ properties: {}
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml
index 3e12386930..0843980500 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml
@@ -1,29 +1,15 @@
type: object
-description: The details of the invite to be accepted.
+description: SUMMARY
+x-schemaName: AdminPostInvitesInviteAcceptReq
required:
- - token
- - user
+ - first_name
+ - last_name
properties:
- token:
- description: >-
- The token of the invite to accept. This is a unique token generated when
- the invite was created or resent.
+ first_name:
type: string
- user:
- description: The details of the user to create.
- type: object
- required:
- - first_name
- - last_name
- - password
- properties:
- first_name:
- type: string
- description: the first name of the User
- last_name:
- type: string
- description: the last name of the User
- password:
- description: The password for the User
- type: string
- format: password
+ title: first_name
+ description: The invite's first name.
+ last_name:
+ type: string
+ title: last_name
+ description: The invite's last name.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesReq.yaml
deleted file mode 100644
index 5cad953bc6..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostInvitesReq.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-type: object
-required:
- - user
- - role
-properties:
- user:
- description: >-
- The email associated with the invite. Once the invite is accepted, the
- email will be associated with the created user.
- type: string
- format: email
- role:
- description: >-
- The role of the user to be created. This does not actually change the
- privileges of the user that is eventually created.
- type: string
- enum:
- - admin
- - member
- - developer
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml
deleted file mode 100644
index c275eb99c2..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesNoteReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details to update of the note.
-required:
- - value
-properties:
- value:
- type: string
- description: The description of the Note.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml
deleted file mode 100644
index 2ece35fa61..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotesReq.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The details of the note to be created.
-required:
- - resource_id
- - resource_type
- - value
-properties:
- resource_id:
- type: string
- description: >-
- The ID of the resource which the Note relates to. For example, an order
- ID.
- resource_type:
- type: string
- description: The type of resource which the Note relates to. For example, `order`.
- value:
- type: string
- description: The content of the Note to create.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml
deleted file mode 100644
index 8f4484779c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostNotificationsNotificationResendReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The resend details.
-properties:
- to:
- description: >-
- A new address or user identifier that the Notification should be sent to.
- If not provided, the previous `to` field of the notification will be used.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml
deleted file mode 100644
index 988baaa0c3..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsLineItemReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details to create or update of the line item change.
-required:
- - quantity
-properties:
- quantity:
- description: The quantity to update
- type: number
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml
deleted file mode 100644
index ed5d1236f9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsEditLineItemsReq.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-type: object
-description: The details of the line item change to create.
-required:
- - variant_id
- - quantity
-properties:
- variant_id:
- description: The ID of the product variant associated with the item.
- type: string
- quantity:
- description: The quantity of the item.
- type: number
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml
deleted file mode 100644
index 76f864ed6d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsOrderEditReq.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-type: object
-description: The details to update of the order edit.
-properties:
- internal_note:
- description: An optional note to create or update in the order edit.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml
deleted file mode 100644
index 5e3b9ce6f1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReq.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-description: The details of the order edit to create.
-required:
- - order_id
-properties:
- order_id:
- description: The ID of the order to create the edit for.
- type: string
- internal_note:
- description: An optional note to associate with the order edit.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml
deleted file mode 100644
index e19eb4e160..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimFulfillmentsReq.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-properties:
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this Claim.
- type: boolean
- location_id:
- description: The ID of the fulfillment's location.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml
deleted file mode 100644
index 273c864064..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimReq.yaml
+++ /dev/null
@@ -1,93 +0,0 @@
-type: object
-properties:
- claim_items:
- description: The Claim Items that the Claim will consist of.
- type: array
- items:
- type: object
- required:
- - id
- - images
- - tags
- properties:
- id:
- description: The ID of the Claim Item.
- type: string
- item_id:
- description: The ID of the Line Item that will be claimed.
- type: string
- quantity:
- description: The number of items that will be returned
- type: integer
- note:
- description: Short text describing the Claim Item in further detail.
- type: string
- reason:
- description: The reason for the Claim
- type: string
- enum:
- - missing_item
- - wrong_item
- - production_failure
- - other
- tags:
- description: A list o tags to add to the Claim Item
- type: array
- items:
- type: object
- properties:
- id:
- type: string
- description: Tag ID
- value:
- type: string
- description: Tag value
- images:
- description: A list of image URL's that will be associated with the Claim
- type: array
- items:
- type: object
- properties:
- id:
- type: string
- description: Image ID
- url:
- type: string
- description: Image URL
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: >-
- Learn about the metadata attribute, and how to delete and update
- it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- shipping_methods:
- description: The Shipping Methods to send the additional Line Items with.
- type: array
- items:
- type: object
- properties:
- id:
- description: The ID of an existing Shipping Method
- type: string
- option_id:
- description: The ID of the Shipping Option to create a Shipping Method from
- type: string
- price:
- description: The price to charge for the Shipping Method
- type: integer
- data:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- no_notification:
- description: If set to true no notification will be send related to this Swap.
- type: boolean
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml
deleted file mode 100644
index 1599973734..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsClaimShipmentsReq.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-required:
- - fulfillment_id
-properties:
- fulfillment_id:
- description: The ID of the Fulfillment.
- type: string
- tracking_numbers:
- description: An array of tracking numbers for the shipment.
- type: array
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml
deleted file mode 100644
index ff71675024..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderClaimsReq.yaml
+++ /dev/null
@@ -1,124 +0,0 @@
-type: object
-description: The details of the claim to be created.
-required:
- - type
- - claim_items
-properties:
- type:
- description: >-
- The type of the Claim. This will determine how the Claim is treated:
- `replace` Claims will result in a Fulfillment with new items being
- created, while a `refund` Claim will refund the amount paid for the
- claimed items.
- type: string
- enum:
- - replace
- - refund
- claim_items:
- description: The Claim Items that the Claim will consist of.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the Line Item that will be claimed.
- type: string
- quantity:
- description: The number of items that will be returned
- type: integer
- note:
- description: Short text describing the Claim Item in further detail.
- type: string
- reason:
- description: The reason for the Claim
- type: string
- enum:
- - missing_item
- - wrong_item
- - production_failure
- - other
- tags:
- description: A list of tags to add to the Claim Item
- type: array
- items:
- type: string
- images:
- description: A list of image URL's that will be associated with the Claim
- items:
- type: string
- return_shipping:
- description: >-
- Optional details for the Return Shipping Method, if the items are to be
- sent back. Providing this field will result in a return being created and
- associated with the claim.
- type: object
- properties:
- option_id:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- price:
- type: integer
- description: The price to charge for the Shipping Method.
- additional_items:
- description: >-
- The new items to send to the Customer. This is only used if the claim's
- type is `replace`.
- type: array
- items:
- type: object
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- description: The ID of the Product Variant.
- type: string
- quantity:
- description: The quantity of the Product Variant.
- type: integer
- shipping_methods:
- description: >-
- The Shipping Methods to send the additional Line Items with. This is only
- used if the claim's type is `replace`.
- type: array
- items:
- type: object
- properties:
- id:
- description: The ID of an existing Shipping Method
- type: string
- option_id:
- description: The ID of the Shipping Option to create a Shipping Method from
- type: string
- price:
- description: The price to charge for the Shipping Method
- type: integer
- data:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- shipping_address:
- description: >-
- An optional shipping address to send the claimed items to. If not
- provided, the parent order's shipping address will be used.
- $ref: ./AddressPayload.yaml
- refund_amount:
- description: >-
- The amount to refund the customer. This is used when the claim's type is
- `refund`.
- type: integer
- no_notification:
- description: If set to true no notification will be send related to this Claim.
- type: boolean
- return_location_id:
- description: The ID of the location used for the associated return.
- type: string
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml
deleted file mode 100644
index 1eb020638b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderFulfillmentsReq.yaml
+++ /dev/null
@@ -1,35 +0,0 @@
-type: object
-description: The details of the fulfillment to be created.
-required:
- - items
-properties:
- items:
- description: The Line Items to include in the Fulfillment.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the Line Item to fulfill.
- type: string
- quantity:
- description: The quantity of the Line Item to fulfill.
- type: integer
- location_id:
- type: string
- description: The ID of the location where the items will be fulfilled from.
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this fulfillment.
- type: boolean
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml
deleted file mode 100644
index 07db31127d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderRefundsReq.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The details of the order refund.
-required:
- - amount
- - reason
-properties:
- amount:
- description: >-
- The amount to refund. It should be less than or equal the
- `refundable_amount` of the order.
- type: integer
- reason:
- description: The reason for the Refund.
- type: string
- note:
- description: A note with additional details about the Refund.
- type: string
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this Refund.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml
deleted file mode 100644
index fa7a2a7530..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReq.yaml
+++ /dev/null
@@ -1,64 +0,0 @@
-type: object
-description: The details to update of the order.
-properties:
- email:
- description: The email associated with the order
- type: string
- billing_address:
- description: The order's billing address
- $ref: ./AddressPayload.yaml
- shipping_address:
- description: The order's shipping address
- $ref: ./AddressPayload.yaml
- items:
- description: The line items of the order
- type: array
- items:
- $ref: ./LineItem.yaml
- region:
- description: ID of the region that the order is associated with.
- type: string
- discounts:
- description: The discounts applied to the order
- type: array
- items:
- $ref: ./Discount.yaml
- customer_id:
- description: The ID of the customer associated with the order.
- type: string
- payment_method:
- description: The payment method chosen for the order.
- type: object
- properties:
- provider_id:
- type: string
- description: The ID of the payment provider.
- data:
- description: Any data relevant for the given payment method.
- type: object
- shipping_method:
- description: The Shipping Method used for shipping the order.
- type: object
- properties:
- provider_id:
- type: string
- description: The ID of the shipping provider.
- profile_id:
- type: string
- description: The ID of the shipping profile.
- price:
- type: integer
- description: The price of the shipping.
- data:
- type: object
- description: Any data relevant to the specific shipping method.
- items:
- type: array
- items:
- $ref: ./LineItem.yaml
- description: Items to ship
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this order.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml
deleted file mode 100644
index 6526c405a8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderReturnsReq.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-type: object
-description: The details of the requested return.
-required:
- - items
-properties:
- items:
- description: The line items that will be returned.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the Line Item.
- type: string
- reason_id:
- description: The ID of the Return Reason to use.
- type: string
- note:
- description: An optional note with information about the Return.
- type: string
- quantity:
- description: The quantity of the Line Item.
- type: integer
- return_shipping:
- description: The Shipping Method to be used to handle the return shipment.
- type: object
- properties:
- option_id:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- price:
- type: integer
- description: The price to charge for the Shipping Method.
- note:
- description: An optional note with information about the Return.
- type: string
- receive_now:
- description: >-
- A flag to indicate if the Return should be registerd as received
- immediately.
- type: boolean
- default: false
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this Return.
- type: boolean
- refund:
- description: The amount to refund.
- type: integer
- location_id:
- description: The ID of the location used for the return.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml
deleted file mode 100644
index 164ef75638..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShipmentReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the shipment to create.
-required:
- - fulfillment_id
-properties:
- fulfillment_id:
- description: The ID of the Fulfillment.
- type: string
- tracking_numbers:
- description: The tracking numbers for the shipment.
- type: array
- items:
- type: string
- no_notification:
- description: If set to true no notification will be send related to this Shipment.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml
deleted file mode 100644
index ec49d666e9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderShippingMethodsReq.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The shipping method's details.
-required:
- - price
- - option_id
-properties:
- price:
- type: number
- description: The price (excluding VAT) that should be charged for the Shipping Method
- option_id:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- data:
- type: object
- description: >-
- The data required for the Shipping Option to create a Shipping Method.
- This depends on the Fulfillment Provider.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml
deleted file mode 100644
index 75ca36674a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsReq.yaml
+++ /dev/null
@@ -1,85 +0,0 @@
-type: object
-description: The details of the swap to create.
-required:
- - return_items
-properties:
- return_items:
- description: The Line Items to associate with the swap's return.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the Line Item that will be returned.
- type: string
- quantity:
- description: The number of items that will be returned
- type: integer
- reason_id:
- description: The ID of the Return Reason to use.
- type: string
- note:
- description: An optional note with information about the Return.
- type: string
- return_shipping:
- description: The shipping method associated with the swap's return.
- type: object
- required:
- - option_id
- properties:
- option_id:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- price:
- type: integer
- description: The price to charge for the Shipping Method.
- additional_items:
- description: The new items to send to the Customer.
- type: array
- items:
- type: object
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- description: The ID of the Product Variant.
- type: string
- quantity:
- description: The quantity of the Product Variant.
- type: integer
- sales_channel_id:
- type: string
- description: The ID of the sales channel associated with the swap.
- custom_shipping_options:
- description: >-
- An array of custom shipping options to potentially create a Shipping
- Method from to send the additional items.
- type: array
- items:
- type: object
- required:
- - option_id
- - price
- properties:
- option_id:
- description: The ID of the Shipping Option.
- type: string
- price:
- description: The custom price of the Shipping Option.
- type: integer
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this Swap.
- type: boolean
- return_location_id:
- type: string
- description: The ID of the location used for the associated return.
- allow_backorder:
- description: If set to `true`, swaps can be completed with items out of stock
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml
deleted file mode 100644
index 8bea2ccb6a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapFulfillmentsReq.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-properties:
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- no_notification:
- description: >-
- If set to `true`, no notification will be sent to the customer related to
- this swap.
- type: boolean
- location_id:
- description: The ID of the fulfillment's location.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml
deleted file mode 100644
index fab12e01e5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrdersOrderSwapsSwapShipmentsReq.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-required:
- - fulfillment_id
-properties:
- fulfillment_id:
- description: The ID of the Fulfillment.
- type: string
- tracking_numbers:
- description: The tracking numbers for the shipment.
- type: array
- items:
- type: string
- no_notification:
- description: If set to true no notification will be sent related to this Claim.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml
deleted file mode 100644
index 25c74f1d4b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentRefundsReq.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-description: The details of the refund to create.
-required:
- - amount
- - reason
-properties:
- amount:
- description: The amount to refund.
- type: integer
- reason:
- description: The reason for the Refund.
- type: string
- note:
- description: A note with additional details about the Refund.
- type: string
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsCapturesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPaymentsRefundsReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml
deleted file mode 100644
index bed0213a0e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListPricesPricesReq.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-type: object
-description: The details of the prices to add.
-properties:
- prices:
- description: The prices to update or add.
- type: array
- items:
- type: object
- required:
- - amount
- - variant_id
- properties:
- id:
- description: The ID of the price.
- type: string
- region_id:
- description: >-
- The ID of the Region for which the price is used. This is only
- required if `currecny_code` is not provided.
- type: string
- currency_code:
- description: >-
- The 3 character ISO currency code for which the price will be used.
- This is only required if `region_id` is not provided.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- variant_id:
- description: The ID of the Variant for which the price is used.
- type: string
- amount:
- description: The amount to charge for the Product Variant.
- type: integer
- min_quantity:
- description: The minimum quantity for which the price will be used.
- type: integer
- max_quantity:
- description: The maximum quantity for which the price will be used.
- type: integer
- override:
- description: >-
- If set to `true`, the prices will replace all existing prices associated
- with the Price List.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml
deleted file mode 100644
index e053f0dbf5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPriceListReq.yaml
+++ /dev/null
@@ -1,83 +0,0 @@
-type: object
-description: The details to update of the payment collection.
-properties:
- name:
- description: The name of the Price List
- type: string
- description:
- description: The description of the Price List.
- type: string
- starts_at:
- description: The date with timezone that the Price List starts being valid.
- type: string
- format: date
- ends_at:
- description: The date with timezone that the Price List ends being valid.
- type: string
- format: date
- type:
- description: The type of the Price List.
- type: string
- enum:
- - sale
- - override
- status:
- description: >-
- The status of the Price List. If the status is set to `draft`, the prices
- created in the price list will not be available of the customer.
- type: string
- enum:
- - active
- - draft
- prices:
- description: The prices of the Price List.
- type: array
- items:
- type: object
- required:
- - amount
- - variant_id
- properties:
- id:
- description: The ID of the price.
- type: string
- region_id:
- description: >-
- The ID of the Region for which the price is used. This is only
- required if `currecny_code` is not provided.
- type: string
- currency_code:
- description: >-
- The 3 character ISO currency code for which the price will be used.
- This is only required if `region_id` is not provided.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- variant_id:
- description: The ID of the Variant for which the price is used.
- type: string
- amount:
- description: The amount to charge for the Product Variant.
- type: integer
- min_quantity:
- description: The minimum quantity for which the price will be used.
- type: integer
- max_quantity:
- description: The maximum quantity for which the price will be used.
- type: integer
- customer_groups:
- type: array
- description: An array of customer groups that the Price List applies to.
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of a customer group
- type: string
- includes_tax:
- description: Tax included in prices of price list
- x-featureFlag: tax_inclusive_pricing
- type: boolean
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
index ec65faee0a..544cae040d 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
@@ -1,85 +1,64 @@
type: object
-description: The details of the price list to create.
+description: SUMMARY
+x-schemaName: AdminPostPriceListsPriceListReq
required:
- - name
- - description
- - type
- prices
properties:
- name:
- description: The name of the Price List.
+ title:
type: string
+ title: title
+ description: The price list's title.
description:
- description: The description of the Price List.
type: string
+ title: description
+ description: The price list's description.
starts_at:
- description: The date with timezone that the Price List starts being valid.
type: string
- format: date
+ title: starts_at
+ description: The price list's starts at.
ends_at:
- description: The date with timezone that the Price List ends being valid.
type: string
- format: date
- type:
- description: The type of the Price List.
- type: string
- enum:
- - sale
- - override
- status:
- description: >-
- The status of the Price List. If the status is set to `draft`, the prices
- created in the price list will not be available of the customer.
- type: string
- enum:
- - active
- - draft
+ title: ends_at
+ description: The price list's ends at.
+ status: {}
+ type: {}
prices:
- description: The prices of the Price List.
type: array
+ description: The price list's prices.
items:
type: object
+ description: The price's prices.
+ x-schemaName: AdminPriceListPricesCreateReq
required:
+ - currency_code
- amount
- variant_id
properties:
- region_id:
- description: >-
- The ID of the Region for which the price is used. This is only
- required if `currecny_code` is not provided.
- type: string
currency_code:
- description: >-
- The 3 character ISO currency code for which the price will be used.
- This is only required if `region_id` is not provided.
type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
+ title: currency_code
+ description: The price's currency code.
amount:
- description: The amount to charge for the Product Variant.
- type: integer
+ type: number
+ title: amount
+ description: The price's amount.
variant_id:
- description: The ID of the Variant for which the price is used.
type: string
+ title: variant_id
+ description: The price's variant id.
min_quantity:
- description: The minimum quantity for which the price will be used.
- type: integer
+ type: number
+ title: min_quantity
+ description: The price's min quantity.
max_quantity:
- description: The maximum quantity for which the price will be used.
- type: integer
- customer_groups:
- type: array
- description: An array of customer groups that the Price List applies to.
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of a customer group
- type: string
- includes_tax:
- description: Tax included in prices of price list
- x-featureFlag: tax_inclusive_pricing
- type: boolean
+ type: number
+ title: max_quantity
+ description: The price's max quantity.
+ rules:
+ type: object
+ description: The price's rules.
+ properties: {}
+ rules:
+ type: object
+ description: The price list's rules.
+ properties: {}
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPriceListsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml
deleted file mode 100644
index 5d95e9141d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryProductsBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the products to add to the product category.
-required:
- - product_ids
-properties:
- product_ids:
- description: The IDs of the products to add to the product category
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- type: string
- description: The ID of the product
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml
deleted file mode 100644
index 066991c4c8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesCategoryReq.yaml
+++ /dev/null
@@ -1,31 +0,0 @@
-type: object
-description: The details to update of the product category.
-properties:
- name:
- type: string
- description: The name to identify the Product Category by.
- description:
- type: string
- description: An optional text field to describe the Product Category by.
- handle:
- type: string
- description: A handle to be used in slugs.
- is_internal:
- type: boolean
- description: A flag to make product category an internal category for admins
- is_active:
- type: boolean
- description: A flag to make product category visible/hidden in the store front
- parent_category_id:
- type: string
- description: The ID of the parent product category
- rank:
- type: number
- description: The rank of the category in the tree node (starting from 0)
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml
deleted file mode 100644
index e68357b5d9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductCategoriesReq.yaml
+++ /dev/null
@@ -1,35 +0,0 @@
-type: object
-description: The details of the product category to create.
-required:
- - name
-properties:
- name:
- type: string
- description: The name of the product category
- description:
- type: string
- description: The description of the product category.
- handle:
- type: string
- description: >-
- The handle of the product category. If none is provided, the kebab-case
- version of the name will be used. This field can be used as a slug in
- URLs.
- is_internal:
- type: boolean
- description: If set to `true`, the product category will only be available to admins.
- is_active:
- type: boolean
- description: >-
- If set to `false`, the product category will not be available in the
- storefront.
- parent_category_id:
- type: string
- description: The ID of the parent product category
- metadata:
- description: An optional set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductMetadataReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductMetadataReq.yaml
deleted file mode 100644
index bb97fc5ea7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductMetadataReq.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-required:
- - key
- - value
-properties:
- key:
- description: The metadata key
- type: string
- value:
- description: The metadata value
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsOption.yaml
deleted file mode 100644
index 2e287f30d7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsOption.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - title
-properties:
- title:
- description: The title of the Product Option
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml
deleted file mode 100644
index a8aebb777b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductOptionsReq.yaml
+++ /dev/null
@@ -1,9 +0,0 @@
-type: object
-description: The details of the product option to create.
-required:
- - title
-properties:
- title:
- description: The title the Product Option.
- type: string
- example: Size
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml
deleted file mode 100644
index d493778ddf..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductReq.yaml
+++ /dev/null
@@ -1,268 +0,0 @@
-type: object
-description: The details to update of the product.
-properties:
- title:
- description: The title of the Product
- type: string
- subtitle:
- description: The subtitle of the Product
- type: string
- description:
- description: The description of the Product.
- type: string
- discountable:
- description: >-
- A flag to indicate if discounts can be applied to the Line Items generated
- from this Product
- type: boolean
- images:
- description: >-
- An array of images of the Product. Each value in the array is a URL to the
- image. You can use the upload API Routes to upload the image and obtain a
- URL.
- type: array
- items:
- type: string
- thumbnail:
- description: >-
- The thumbnail to use for the Product. The value is a URL to the thumbnail.
- You can use the upload API Routes to upload the thumbnail and obtain a
- URL.
- type: string
- handle:
- description: >-
- A unique handle to identify the Product by. If not provided, the
- kebab-case version of the product title will be used. This can be used as
- a slug in URLs.
- type: string
- status:
- description: >-
- The status of the product. The product is shown to the customer only if
- its status is `published`.
- type: string
- enum:
- - draft
- - proposed
- - published
- - rejected
- type:
- description: The Product Type to associate the Product with.
- type: object
- required:
- - value
- properties:
- id:
- description: >-
- The ID of an existing Product Type. If not provided, a new product
- type will be created.
- type: string
- value:
- description: The value of the Product Type.
- type: string
- collection_id:
- description: The ID of the Product Collection the Product belongs to.
- type: string
- tags:
- description: Product Tags to associate the Product with.
- type: array
- items:
- type: object
- required:
- - value
- properties:
- id:
- description: >-
- The ID of an existing Product Tag. If not provided, a new product
- tag will be created.
- type: string
- value:
- description: >-
- The value of the Tag. If the `id` is provided, the value of the
- existing tag will be updated.
- type: string
- sales_channels:
- description: Sales channels to associate the Product with.
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of an existing Sales channel.
- type: string
- categories:
- description: Product categories to add the Product to.
- x-featureFlag: product_categories
- type: array
- items:
- required:
- - id
- properties:
- id:
- description: The ID of a Product Category.
- type: string
- variants:
- description: >-
- An array of Product Variants to create with the Product. Each product
- variant must have a unique combination of Product Option values.
- type: array
- items:
- type: object
- properties:
- id:
- description: >-
- The id of an existing product variant. If provided, the details of
- the product variant will be updated. If not, a new product variant
- will be created.
- type: string
- title:
- description: The title of the product variant.
- type: string
- sku:
- description: The unique SKU of the product variant.
- type: string
- ean:
- description: The EAN number of the product variant.
- type: string
- upc:
- description: The UPC number of the product variant.
- type: string
- barcode:
- description: A generic GTIN field of the product variant.
- type: string
- hs_code:
- description: The Harmonized System code of the product variant.
- type: string
- inventory_quantity:
- description: The amount of stock kept of the product variant.
- type: integer
- allow_backorder:
- description: Whether the product variant can be purchased when out of stock.
- type: boolean
- manage_inventory:
- description: >-
- Whether Medusa should keep track of the inventory of this product
- variant.
- type: boolean
- weight:
- description: The weight of the product variant.
- type: number
- length:
- description: The length of the product variant.
- type: number
- height:
- description: The height of the product variant.
- type: number
- width:
- description: The width of the product variant.
- type: number
- origin_country:
- description: The country of origin of the product variant.
- type: string
- mid_code:
- description: The Manufacturer Identification code of the product variant.
- type: string
- material:
- description: The material composition of the product variant.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: >-
- Learn about the metadata attribute, and how to delete and update
- it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- prices:
- type: array
- description: >-
- An array of product variant prices. A product variant can have
- different prices for each region or currency code.
- externalDocs:
- url: >-
- https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
- description: Product variant pricing.
- items:
- type: object
- required:
- - amount
- properties:
- id:
- description: >-
- The ID of the Price. If provided, the existing price will be
- updated. Otherwise, a new price will be created.
- type: string
- region_id:
- description: >-
- The ID of the Region the price will be used in. This is only
- required if `currency_code` is not provided.
- type: string
- currency_code:
- description: >-
- The 3 character ISO currency code the price will be used in.
- This is only required if `region_id` is not provided.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- amount:
- description: The price amount.
- type: integer
- min_quantity:
- description: >-
- The minimum quantity required to be added to the cart for the
- price to be used.
- type: integer
- max_quantity:
- description: >-
- The maximum quantity required to be added to the cart for the
- price to be used.
- type: integer
- options:
- type: array
- description: An array of Product Option values that the variant corresponds to.
- items:
- type: object
- required:
- - option_id
- - value
- properties:
- option_id:
- description: The ID of the Option.
- type: string
- value:
- description: The value of the Product Option.
- type: string
- weight:
- description: The weight of the Product.
- type: number
- length:
- description: The length of the Product.
- type: number
- height:
- description: The height of the Product.
- type: number
- width:
- description: The width of the Product.
- type: number
- hs_code:
- description: The Harmonized System code of the product variant.
- type: string
- origin_country:
- description: The country of origin of the Product.
- type: string
- mid_code:
- description: The Manufacturer Identification code of the Product.
- type: string
- material:
- description: The material composition of the Product.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml
deleted file mode 100644
index 4714294c7f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsReq.yaml
+++ /dev/null
@@ -1,119 +0,0 @@
-type: object
-description: The details of the product variant to create.
-required:
- - title
- - prices
- - options
-properties:
- title:
- description: The title of the product variant.
- type: string
- sku:
- description: The unique SKU of the product variant.
- type: string
- ean:
- description: The EAN number of the product variant.
- type: string
- upc:
- description: The UPC number of the product variant.
- type: string
- barcode:
- description: A generic GTIN field of the product variant.
- type: string
- hs_code:
- description: The Harmonized System code of the product variant.
- type: string
- inventory_quantity:
- description: The amount of stock kept of the product variant.
- type: integer
- default: 0
- allow_backorder:
- description: Whether the product variant can be purchased when out of stock.
- type: boolean
- manage_inventory:
- description: Whether Medusa should keep track of the inventory of this product variant.
- type: boolean
- default: true
- weight:
- description: The wieght of the product variant.
- type: number
- length:
- description: The length of the product variant.
- type: number
- height:
- description: The height of the product variant.
- type: number
- width:
- description: The width of the product variant.
- type: number
- origin_country:
- description: The country of origin of the product variant.
- type: string
- mid_code:
- description: The Manufacturer Identification code of the product variant.
- type: string
- material:
- description: The material composition of the product variant.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- prices:
- type: array
- description: >-
- An array of product variant prices. A product variant can have different
- prices for each region or currency code.
- externalDocs:
- url: >-
- https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
- description: Product variant pricing.
- items:
- type: object
- required:
- - amount
- properties:
- region_id:
- description: >-
- The ID of the Region the price will be used in. This is only
- required if `currency_code` is not provided.
- type: string
- currency_code:
- description: >-
- The 3 character ISO currency code the price will be used in. This is
- only required if `region_id` is not provided.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- amount:
- description: The price amount.
- type: integer
- min_quantity:
- description: >-
- The minimum quantity required to be added to the cart for the price
- to be used.
- type: integer
- max_quantity:
- description: >-
- The maximum quantity required to be added to the cart for the price
- to be used.
- type: integer
- options:
- type: array
- description: An array of Product Option values that the variant corresponds to.
- items:
- type: object
- required:
- - option_id
- - value
- properties:
- option_id:
- description: The ID of the Product Option.
- type: string
- value:
- description: A value to give to the Product Option.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsVariantReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsVariantReq.yaml
deleted file mode 100644
index af5c4c58a6..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsProductVariantsVariantReq.yaml
+++ /dev/null
@@ -1,117 +0,0 @@
-type: object
-properties:
- title:
- description: The title of the product variant.
- type: string
- sku:
- description: The unique SKU of the product variant.
- type: string
- ean:
- description: The EAN number of the item.
- type: string
- upc:
- description: The UPC number of the item.
- type: string
- barcode:
- description: A generic GTIN field of the product variant.
- type: string
- hs_code:
- description: The Harmonized System code of the product variant.
- type: string
- inventory_quantity:
- description: The amount of stock kept of the product variant.
- type: integer
- allow_backorder:
- description: Whether the product variant can be purchased when out of stock.
- type: boolean
- manage_inventory:
- description: Whether Medusa should keep track of the inventory of this product variant.
- type: boolean
- weight:
- description: The weight of the product variant.
- type: number
- length:
- description: The length of the product variant.
- type: number
- height:
- description: The height of the product variant.
- type: number
- width:
- description: The width of the product variant.
- type: number
- origin_country:
- description: The country of origin of the product variant.
- type: string
- mid_code:
- description: The Manufacturer Identification code of the product variant.
- type: string
- material:
- description: The material composition of the product variant.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- prices:
- type: array
- description: >-
- An array of product variant prices. A product variant can have different
- prices for each region or currency code.
- externalDocs:
- url: >-
- https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
- description: Product variant pricing.
- items:
- type: object
- required:
- - amount
- properties:
- id:
- description: >-
- The ID of the price. If provided, the existing price will be
- updated. Otherwise, a new price will be created.
- type: string
- region_id:
- description: >-
- The ID of the Region the price will be used in. This is only
- required if `currency_code` is not provided.
- type: string
- currency_code:
- description: >-
- The 3 character ISO currency code the price will be used in. This is
- only required if `region_id` is not provided.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- amount:
- description: The price amount.
- type: integer
- min_quantity:
- description: >-
- The minimum quantity required to be added to the cart for the price
- to be used.
- type: integer
- max_quantity:
- description: >-
- The maximum quantity required to be added to the cart for the price
- to be used.
- type: integer
- options:
- type: array
- description: An array of Product Option values that the variant corresponds to.
- items:
- type: object
- required:
- - option_id
- - value
- properties:
- option_id:
- description: The ID of the Product Option.
- type: string
- value:
- description: The value of the Product Option.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml
deleted file mode 100644
index 1af53e32cc..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsReq.yaml
+++ /dev/null
@@ -1,290 +0,0 @@
-type: object
-description: The details of the product to create.
-required:
- - title
-properties:
- title:
- description: The title of the Product
- type: string
- subtitle:
- description: The subtitle of the Product
- type: string
- description:
- description: The description of the Product.
- type: string
- is_giftcard:
- description: >-
- A flag to indicate if the Product represents a Gift Card. Purchasing
- Products with this flag set to `true` will result in a Gift Card being
- created.
- type: boolean
- default: false
- discountable:
- description: >-
- A flag to indicate if discounts can be applied to the Line Items generated
- from this Product
- type: boolean
- default: true
- images:
- description: >-
- An array of images of the Product. Each value in the array is a URL to the
- image. You can use the upload API Routes to upload the image and obtain a
- URL.
- type: array
- items:
- type: string
- thumbnail:
- description: >-
- The thumbnail to use for the Product. The value is a URL to the thumbnail.
- You can use the upload API Routes to upload the thumbnail and obtain a
- URL.
- type: string
- handle:
- description: >-
- A unique handle to identify the Product by. If not provided, the
- kebab-case version of the product title will be used. This can be used as
- a slug in URLs.
- type: string
- status:
- description: >-
- The status of the product. The product is shown to the customer only if
- its status is `published`.
- type: string
- enum:
- - draft
- - proposed
- - published
- - rejected
- default: draft
- type:
- description: The Product Type to associate the Product with.
- type: object
- required:
- - value
- properties:
- id:
- description: >-
- The ID of an existing Product Type. If not provided, a new product
- type will be created.
- type: string
- value:
- description: The value of the Product Type.
- type: string
- collection_id:
- description: The ID of the Product Collection the Product belongs to.
- type: string
- tags:
- description: Product Tags to associate the Product with.
- type: array
- items:
- type: object
- required:
- - value
- properties:
- id:
- description: >-
- The ID of an existing Product Tag. If not provided, a new product
- tag will be created.
- type: string
- value:
- description: >-
- The value of the Tag. If the `id` is provided, the value of the
- existing tag will be updated.
- type: string
- sales_channels:
- description: Sales channels to associate the Product with.
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of an existing Sales channel.
- type: string
- categories:
- description: Product categories to add the Product to.
- x-featureFlag: product_categories
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- description: The ID of a Product Category.
- type: string
- options:
- description: >-
- The Options that the Product should have. A new product option will be
- created for every item in the array.
- type: array
- items:
- type: object
- required:
- - title
- properties:
- title:
- description: The title of the Product Option.
- type: string
- variants:
- description: >-
- An array of Product Variants to create with the Product. Each product
- variant must have a unique combination of Product Option values.
- type: array
- items:
- type: object
- required:
- - title
- properties:
- title:
- description: The title of the Product Variant.
- type: string
- sku:
- description: The unique SKU of the Product Variant.
- type: string
- ean:
- description: The EAN number of the item.
- type: string
- upc:
- description: The UPC number of the item.
- type: string
- barcode:
- description: A generic GTIN field of the Product Variant.
- type: string
- hs_code:
- description: The Harmonized System code of the Product Variant.
- type: string
- inventory_quantity:
- description: The amount of stock kept of the Product Variant.
- type: integer
- default: 0
- allow_backorder:
- description: Whether the Product Variant can be purchased when out of stock.
- type: boolean
- manage_inventory:
- description: >-
- Whether Medusa should keep track of the inventory of this Product
- Variant.
- type: boolean
- weight:
- description: The wieght of the Product Variant.
- type: number
- length:
- description: The length of the Product Variant.
- type: number
- height:
- description: The height of the Product Variant.
- type: number
- width:
- description: The width of the Product Variant.
- type: number
- origin_country:
- description: The country of origin of the Product Variant.
- type: string
- mid_code:
- description: The Manufacturer Identification code of the Product Variant.
- type: string
- material:
- description: The material composition of the Product Variant.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: >-
- Learn about the metadata attribute, and how to delete and update
- it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- prices:
- type: array
- description: >-
- An array of product variant prices. A product variant can have
- different prices for each region or currency code.
- externalDocs:
- url: >-
- https://docs.medusajs.com/modules/products/admin/manage-products#product-variant-prices
- description: Product variant pricing.
- items:
- type: object
- required:
- - amount
- properties:
- region_id:
- description: >-
- The ID of the Region the price will be used in. This is only
- required if `currency_code` is not provided.
- type: string
- currency_code:
- description: >-
- The 3 character ISO currency code the price will be used in.
- This is only required if `region_id` is not provided.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- amount:
- description: The price amount.
- type: integer
- min_quantity:
- description: >-
- The minimum quantity required to be added to the cart for the
- price to be used.
- type: integer
- max_quantity:
- description: >-
- The maximum quantity required to be added to the cart for the
- price to be used.
- type: integer
- options:
- type: array
- description: >-
- An array of Product Option values that the variant corresponds to.
- The option values should be added into the array in the same index
- as in the `options` field of the product.
- externalDocs:
- url: >-
- https://docs.medusajs.com/modules/products/admin/manage-products#create-a-product
- description: Example of how to create a product with options and variants
- items:
- type: object
- required:
- - value
- properties:
- value:
- description: >-
- The value to give for the Product Option at the same index in
- the Product's `options` field.
- type: string
- weight:
- description: The weight of the Product.
- type: number
- length:
- description: The length of the Product.
- type: number
- height:
- description: The height of the Product.
- type: number
- width:
- description: The width of the Product.
- type: number
- hs_code:
- description: The Harmonized System code of the Product.
- type: string
- origin_country:
- description: The country of origin of the Product.
- type: string
- mid_code:
- description: The Manufacturer Identification code of the Product.
- type: string
- material:
- description: The material composition of the Product.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml
deleted file mode 100644
index 9dea69c4f5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostProductsToCollectionReq.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-description: The details of the products to add to the collection.
-required:
- - product_ids
-properties:
- product_ids:
- description: An array of Product IDs to add to the Product Collection.
- type: array
- items:
- description: The ID of a Product to add to the Product Collection.
- type: string
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml
deleted file mode 100644
index e4488d0be6..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeySalesChannelsBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the sales channels to add to the publishable API key.
-required:
- - sales_channel_ids
-properties:
- sales_channel_ids:
- description: The IDs of the sales channels to add to the publishable API key
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- type: string
- description: The ID of the sales channel
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml
deleted file mode 100644
index 7a546010fd..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-type: object
-description: The details to update of the publishable API key.
-properties:
- title:
- description: The title of the Publishable API Key.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml
deleted file mode 100644
index 64bce0a179..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostPublishableApiKeysReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the publishable API key to create.
-required:
- - title
-properties:
- title:
- description: The title of the publishable API key
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml
deleted file mode 100644
index 67711cf9c0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionCountriesReq.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-description: The details of the country to add to the region.
-required:
- - country_code
-properties:
- country_code:
- description: The 2 character ISO code for the Country.
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml
deleted file mode 100644
index f952ecb909..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionFulfillmentProvidersReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the fulfillment provider to add to the region.
-required:
- - provider_id
-properties:
- provider_id:
- description: The ID of the Fulfillment Provider.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml
deleted file mode 100644
index eec9ff73b8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionPaymentProvidersReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the payment provider to add to the region.
-required:
- - provider_id
-properties:
- provider_id:
- description: The ID of the Payment Provider.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml
deleted file mode 100644
index f979ec56b9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsRegionReq.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-type: object
-description: The details to update of the regions.
-properties:
- name:
- description: The name of the Region
- type: string
- currency_code:
- description: The 3 character ISO currency code to use in the Region.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- automatic_taxes:
- description: >-
- If set to `true`, the Medusa backend will automatically calculate taxes
- for carts in this region. If set to `false`, the taxes must be calculated
- manually.
- externalDocs:
- url: https://docs.medusajs.com/modules/taxes/storefront/manual-calculation
- description: How to calculate taxes in a storefront.
- type: boolean
- gift_cards_taxable:
- description: If set to `true`, taxes will be applied on gift cards.
- type: boolean
- tax_provider_id:
- description: >-
- The ID of the tax provider to use. If none provided, the system tax
- provider is used.
- type: string
- tax_code:
- description: The tax code of the Region.
- type: string
- tax_rate:
- description: The tax rate to use in the Region.
- type: number
- includes_tax:
- x-featureFlag: tax_inclusive_pricing
- description: Whether taxes are included in the prices of the region.
- type: boolean
- payment_providers:
- description: A list of Payment Provider IDs that can be used in the Region
- type: array
- items:
- type: string
- fulfillment_providers:
- description: A list of Fulfillment Provider IDs that can be used in the Region
- type: array
- items:
- type: string
- countries:
- description: >-
- A list of countries' 2 ISO characters that should be included in the
- Region.
- type: array
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml
deleted file mode 100644
index 7b81a1cf9d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostRegionsReq.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-type: object
-description: The details of the region to create.
-required:
- - name
- - currency_code
- - tax_rate
- - payment_providers
- - fulfillment_providers
- - countries
-properties:
- name:
- description: The name of the Region
- type: string
- currency_code:
- description: The 3 character ISO currency code to use in the Region.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- tax_code:
- description: The tax code of the Region.
- type: string
- tax_rate:
- description: The tax rate to use in the Region.
- type: number
- payment_providers:
- description: A list of Payment Provider IDs that can be used in the Region
- type: array
- items:
- type: string
- fulfillment_providers:
- description: A list of Fulfillment Provider IDs that can be used in the Region
- type: array
- items:
- type: string
- countries:
- description: >-
- A list of countries' 2 ISO characters that should be included in the
- Region.
- example:
- - US
- type: array
- items:
- type: string
- includes_tax:
- x-featureFlag: tax_inclusive_pricing
- description: Whether taxes are included in the prices of the region.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml
deleted file mode 100644
index 03fe9386f4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReq.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-type: object
-description: The details of the reservation to create.
-required:
- - location_id
- - inventory_item_id
- - quantity
-properties:
- line_item_id:
- description: The ID of the line item of the reservation.
- type: string
- location_id:
- description: The ID of the location of the reservation.
- type: string
- inventory_item_id:
- description: The ID of the inventory item the reservation is associated with.
- type: string
- quantity:
- description: The quantity to reserve.
- type: number
- description:
- description: The reservation's description.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml
deleted file mode 100644
index 87e6d986ca..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReservationsReservationReq.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-type: object
-description: The details to update of the reservation.
-properties:
- location_id:
- description: The ID of the location associated with the reservation.
- type: string
- quantity:
- description: The quantity to reserve.
- type: number
- description:
- description: The reservation's description.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml
deleted file mode 100644
index 210fd0ce29..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReasonReq.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-type: object
-description: The details to update of the return reason.
-properties:
- label:
- description: The label to display to the Customer.
- type: string
- value:
- description: A unique value of the return reason.
- type: string
- description:
- description: The description of the Reason.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml
deleted file mode 100644
index c279b67d5b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnReasonsReq.yaml
+++ /dev/null
@@ -1,25 +0,0 @@
-type: object
-description: The details of the return reason to create.
-required:
- - label
- - value
-properties:
- label:
- description: The label to display to the Customer.
- type: string
- value:
- description: A unique value of the return reason.
- type: string
- parent_return_reason_id:
- description: The ID of the parent return reason.
- type: string
- description:
- description: The description of the Reason.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml
deleted file mode 100644
index 1df680e512..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReceiveReq.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-type: object
-description: The details of the received return.
-required:
- - items
-properties:
- items:
- description: The Line Items that have been received.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the Line Item.
- type: string
- quantity:
- description: The quantity of the Line Item.
- type: integer
- refund:
- description: The amount to refund.
- type: number
- location_id:
- description: The ID of the location to return items from.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml
deleted file mode 100644
index 1ea7c4dccc..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelProductsBatchReq.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The details of the products to add to the sales channel.
-required:
- - product_ids
-properties:
- product_ids:
- description: The IDs of the products to add to the sales channel
- type: array
- items:
- type: object
- required:
- - id
- properties:
- id:
- type: string
- description: The ID of the product
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml
deleted file mode 100644
index a62aecc7e0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsChannelStockLocationsReq.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - location_id
-properties:
- location_id:
- description: The ID of the stock location
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml
deleted file mode 100644
index 350e640c6e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsReq.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: The details of the sales channel to create.
-required:
- - name
-properties:
- name:
- description: The name of the Sales Channel
- type: string
- description:
- description: The description of the Sales Channel
- type: string
- is_disabled:
- description: Whether the Sales Channel is disabled.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml
deleted file mode 100644
index b19fe3093e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostSalesChannelsSalesChannelReq.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-description: The details to update of the sales channel.
-properties:
- name:
- type: string
- description: The name of the sales channel
- description:
- type: string
- description: The description of the sales channel.
- is_disabled:
- type: boolean
- description: Whether the Sales Channel is disabled.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml
deleted file mode 100644
index b203c31f1c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsOptionReq.yaml
+++ /dev/null
@@ -1,55 +0,0 @@
-type: object
-description: The details to update of the shipping option.
-required:
- - requirements
-properties:
- name:
- description: The name of the Shipping Option
- type: string
- amount:
- description: >-
- The amount to charge for the Shipping Option. If the `price_type` of the
- shipping option is `calculated`, this amount will not actually be used.
- type: integer
- admin_only:
- description: >-
- If set to `true`, the shipping option can only be used when creating draft
- orders.
- type: boolean
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- requirements:
- description: >-
- The requirements that must be satisfied for the Shipping Option to be
- available.
- type: array
- items:
- type: object
- required:
- - type
- - amount
- properties:
- id:
- description: >-
- The ID of an existing requirement. If an ID is passed, the existing
- requirement's details are updated. Otherwise, a new requirement is
- created.
- type: string
- type:
- description: The type of the requirement
- type: string
- enum:
- - max_subtotal
- - min_subtotal
- amount:
- description: The amount to compare with.
- type: integer
- includes_tax:
- description: Tax included in prices of shipping option
- x-featureFlag: tax_inclusive_pricing
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml
deleted file mode 100644
index ded76946d4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingOptionsReq.yaml
+++ /dev/null
@@ -1,81 +0,0 @@
-type: object
-description: The details of the shipping option to create.
-required:
- - name
- - region_id
- - provider_id
- - data
- - price_type
-properties:
- name:
- description: The name of the Shipping Option
- type: string
- region_id:
- description: The ID of the Region in which the Shipping Option will be available.
- type: string
- provider_id:
- description: The ID of the Fulfillment Provider that handles the Shipping Option.
- type: string
- profile_id:
- description: The ID of the Shipping Profile to add the Shipping Option to.
- type: number
- data:
- description: >-
- The data needed for the Fulfillment Provider to handle shipping with this
- Shipping Option.
- type: object
- price_type:
- description: >-
- The type of the Shipping Option price. `flat_rate` indicates fixed
- pricing, whereas `calculated` indicates that the price will be calculated
- each time by the fulfillment provider.
- type: string
- enum:
- - flat_rate
- - calculated
- amount:
- description: >-
- The amount to charge for the Shipping Option. If the `price_type` is set
- to `calculated`, this amount will not actually be used.
- type: integer
- requirements:
- description: >-
- The requirements that must be satisfied for the Shipping Option to be
- available.
- type: array
- items:
- type: object
- required:
- - type
- - amount
- properties:
- type:
- description: The type of the requirement
- type: string
- enum:
- - max_subtotal
- - min_subtotal
- amount:
- description: The amount to compare with.
- type: integer
- is_return:
- description: Whether the Shipping Option can be used for returns or during checkout.
- type: boolean
- default: false
- admin_only:
- description: >-
- If set to `true`, the shipping option can only be used when creating draft
- orders.
- type: boolean
- default: false
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- includes_tax:
- description: Tax included in prices of shipping option
- x-featureFlag: tax_inclusive_pricing
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml
deleted file mode 100644
index 66706941a7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesProfileReq.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-type: object
-description: The detail to update of the shipping profile.
-properties:
- name:
- description: The name of the Shipping Profile
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- type:
- description: The type of the Shipping Profile
- type: string
- enum:
- - default
- - gift_card
- - custom
- products:
- description: product IDs to associate with the Shipping Profile
- type: array
- shipping_options:
- description: Shipping option IDs to associate with the Shipping Profile
- type: array
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml
deleted file mode 100644
index 6811257b50..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostShippingProfilesReq.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-type: object
-description: The details of the shipping profile to create.
-required:
- - name
- - type
-properties:
- name:
- description: The name of the Shipping Profile
- type: string
- type:
- description: The type of the Shipping Profile
- type: string
- enum:
- - default
- - gift_card
- - custom
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml
deleted file mode 100644
index 58ba572f61..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsLocationReq.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-description: The details to update of the stock location.
-properties:
- name:
- description: the name of the stock location
- type: string
- address_id:
- description: the stock location address ID
- type: string
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- address:
- description: The data of an associated address to create or update.
- $ref: ./StockLocationAddressInput.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml
index ba6e9ea4d2..a8c1dac40b 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReq.yaml
@@ -1,27 +1,20 @@
type: object
-description: The details of the stock location to create.
+description: SUMMARY
+x-schemaName: AdminPostStockLocationsReq
required:
- name
properties:
name:
- description: the name of the stock location
type: string
+ title: name
+ description: The stock location's name.
+ address:
+ $ref: ./StockLocationAddress.yaml
address_id:
- description: >-
- the ID of an existing stock location address to associate with the stock
- location. Only required if `address` is not provided.
type: string
+ title: address_id
+ description: The stock location's address id.
metadata:
type: object
- description: An optional key-value map with additional details
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- address:
- description: >-
- A new stock location address to create and associate with the stock
- location. Only required if `address_id` is not provided.
- $ref: ./StockLocationAddressInput.yaml
+ description: The stock location's metadata.
+ properties: {}
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml
deleted file mode 100644
index 7d83e82f88..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStockLocationsReqAddress.yaml
+++ /dev/null
@@ -1,39 +0,0 @@
-type: object
-required:
- - address_1
- - country_code
-properties:
- address_1:
- type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
- address_2:
- type: string
- description: Stock location address' complement
- example: apartment 4432
- company:
- type: string
- description: Stock location address' company
- city:
- type: string
- description: Stock location address' city
- example: Mexico city
- country_code:
- description: The two character ISO code for the country.
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- phone:
- type: string
- description: Stock location address' phone number
- example: +1 555 61646
- postal_code:
- type: string
- description: Stock location address' postal code
- example: HD3-1G8
- province:
- type: string
- description: Stock location address' province
- example: Sinaloa
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml
deleted file mode 100644
index 7cedff30fd..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostStoreReq.yaml
+++ /dev/null
@@ -1,43 +0,0 @@
-type: object
-description: The details to update of the store.
-properties:
- name:
- description: The name of the Store
- type: string
- swap_link_template:
- description: A template for Swap links - use `{{cart_id}}` to insert the Swap Cart ID
- type: string
- example: http://example.com/swaps/{{cart_id}}
- payment_link_template:
- description: A template for payment links - use `{{cart_id}}` to insert the Cart ID
- example: http://example.com/payments/{{cart_id}}
- type: string
- invite_link_template:
- description: >-
- A template for invite links - use `{{invite_token}}` to insert the invite
- token
- example: http://example.com/invite?token={{invite_token}}
- type: string
- default_currency_code:
- description: The default currency code of the Store.
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currencies:
- description: >-
- Array of available currencies in the store. Each currency is in 3
- character ISO code format.
- type: array
- items:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml
index 380858f256..31f7a9f5ac 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesReq.yaml
@@ -1,34 +1,54 @@
type: object
-description: The details of the tax rate to create.
+description: SUMMARY
+x-schemaName: AdminPostTaxRatesReq
required:
- - code
- name
- - region_id
+ - tax_region_id
properties:
- code:
- type: string
- description: The code of the tax rate.
- name:
- type: string
- description: The name of the tax rate.
- region_id:
- type: string
- description: The ID of the Region that the tax rate belongs to.
rate:
type: number
- description: The numeric rate to charge.
- products:
+ title: rate
+ description: The tax rate's rate.
+ code:
+ type: string
+ title: code
+ description: The tax rate's code.
+ rules:
type: array
- description: The IDs of the products associated with this tax rate.
+ description: The tax rate's rules.
items:
- type: string
- shipping_options:
- type: array
- description: The IDs of the shipping options associated with this tax rate
- items:
- type: string
- product_types:
- type: array
- description: The IDs of the types of products associated with this tax rate
- items:
- type: string
+ type: object
+ description: The rule's rules.
+ x-schemaName: CreateTaxRateRule
+ required:
+ - reference
+ - reference_id
+ properties:
+ reference:
+ type: string
+ title: reference
+ description: The rule's reference.
+ reference_id:
+ type: string
+ title: reference_id
+ description: The rule's reference id.
+ name:
+ type: string
+ title: name
+ description: The tax rate's name.
+ is_default:
+ type: boolean
+ title: is_default
+ description: The tax rate's is default.
+ is_combinable:
+ type: boolean
+ title: is_combinable
+ description: The tax rate's is combinable.
+ tax_region_id:
+ type: string
+ title: tax_region_id
+ description: The tax rate's tax region id.
+ metadata:
+ type: object
+ description: The tax rate's metadata.
+ properties: {}
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml
deleted file mode 100644
index 3d53e43351..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductTypesReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The product types to add to the tax rate.
-required:
- - product_types
-properties:
- product_types:
- type: array
- description: The IDs of the types of products to associate with this tax rate
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml
deleted file mode 100644
index fe7852a7a0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateProductsReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the products to associat with the tax rate.
-required:
- - products
-properties:
- products:
- type: array
- description: The IDs of the products to associate with this tax rate
- items:
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml
index 2ef465db03..a6c334bdc6 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml
@@ -1,30 +1,41 @@
type: object
-description: The details to update of the tax rate.
+description: SUMMARY
+x-schemaName: AdminPostTaxRatesTaxRateReq
properties:
code:
type: string
- description: The code of the tax rate.
+ title: code
+ description: The tax rate's code.
name:
type: string
- description: The name of the tax rate.
+ title: name
+ description: The tax rate's name.
region_id:
type: string
- description: The ID of the Region that the tax rate belongs to.
+ title: region_id
+ description: The tax rate's region id.
rate:
type: number
- description: The numeric rate to charge.
+ title: rate
+ description: The tax rate's rate.
products:
type: array
- description: The IDs of the products associated with this tax rate
+ description: The tax rate's products.
items:
type: string
+ title: products
+ description: The product's products.
shipping_options:
type: array
- description: The IDs of the shipping options associated with this tax rate
+ description: The tax rate's shipping options.
items:
type: string
+ title: shipping_options
+ description: The shipping option's shipping options.
product_types:
type: array
- description: The IDs of the types of product types associated with this tax rate
+ description: The tax rate's product types.
items:
type: string
+ title: product_types
+ description: The product type's product types.
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml
deleted file mode 100644
index 8daa099db8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRatesTaxRateShippingOptionsReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the shipping options to associate with the tax rate.
-required:
- - shipping_options
-properties:
- shipping_options:
- type: array
- description: The IDs of the shipping options to associate with this tax rate
- items:
- type: string
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRegionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRegionsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRegionsReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostTaxRegionsReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml
deleted file mode 100644
index bb45c04655..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the file to retrieve its download URL.
-required:
- - file_key
-properties:
- file_key:
- description: >-
- key of the file to obtain the download link for. This is obtained when you
- first uploaded the file, or by the file service if you used it directly.
- type: string
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostWorkflowsRunReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsRunReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostWorkflowsRunReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/AdminPostWorkflowsRunReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml
deleted file mode 100644
index 92ba375b0b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteBatchRes.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-type: object
-description: The details of deleting a price list.
-required:
- - ids
- - object
- - deleted
-properties:
- ids:
- type: array
- description: The IDs of the deleted prices.
- items:
- type: string
- description: The ID of a deleted price.
- object:
- type: string
- description: >-
- The type of the object that was deleted. A price is also named
- `money-amount`.
- default: money-amount
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml
deleted file mode 100644
index 28f88ffb6d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteProductPricesRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - ids
- - object
- - deleted
-properties:
- ids:
- type: array
- description: The IDs of the deleted prices.
- items:
- type: string
- object:
- type: string
- description: >-
- The type of the object that was deleted. A price is also named
- `money-amount`.
- default: money-amount
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteRes.yaml
deleted file mode 100644
index 0402210313..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Price List.
- object:
- type: string
- description: The type of the object that was deleted.
- default: price-list
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml
deleted file mode 100644
index 28f88ffb6d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListDeleteVariantPricesRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - ids
- - object
- - deleted
-properties:
- ids:
- type: array
- description: The IDs of the deleted prices.
- items:
- type: string
- object:
- type: string
- description: >-
- The type of the object that was deleted. A price is also named
- `money-amount`.
- default: money-amount
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml
deleted file mode 100644
index 723aadc472..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The price list's details.
-x-expanded-relations:
- field: price_list
- relations:
- - customer_groups
- - prices
-required:
- - price_list
-properties:
- price_list:
- description: Price List details.
- $ref: ./PriceList.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml
deleted file mode 100644
index 6a00753e4f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of price lists with pagination fields.
-required:
- - price_lists
- - count
- - offset
- - limit
-properties:
- price_lists:
- type: array
- description: An array of price lists details.
- items:
- $ref: ./PriceList.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of price lists skipped when retrieving the price lists.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml
deleted file mode 100644
index d782773dff..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPriceListsProductsListRes.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-type: object
-description: The list of products with pagination fields.
-x-expanded-relations:
- field: products
- relations:
- - categories
- - collection
- - images
- - options
- - tags
- - type
- - variants
- - variants.options
-required:
- - products
- - count
- - offset
- - limit
-properties:
- products:
- type: array
- description: An array of products details.
- items:
- $ref: ./Product.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of price lists skipped when retrieving the price lists.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryDeleteRes.yaml
deleted file mode 100644
index c9acfd91c0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted product category
- object:
- type: string
- description: The type of the object that was deleted.
- default: product-category
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml
deleted file mode 100644
index 65073b08a6..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesCategoryRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The product category's details.
-x-expanded-relations:
- field: product_category
- relations:
- - category_children
- - parent_category
-required:
- - product_category
-properties:
- product_category:
- description: Product category details.
- $ref: ./ProductCategory.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml
deleted file mode 100644
index ae632ec86c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductCategoriesListRes.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-type: object
-description: The list of product categories with pagination fields.
-x-expanded-relations:
- field: product_categories
- relations:
- - category_children
- - parent_category
-required:
- - product_categories
- - count
- - offset
- - limit
-properties:
- product_categories:
- type: array
- description: An array of product category details.
- items:
- $ref: ./ProductCategory.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of product categories skipped when retrieving the product
- categories.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml
deleted file mode 100644
index 2663c80b5a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of product tags with pagination fields.
-required:
- - product_tags
- - count
- - offset
- - limit
-properties:
- product_tags:
- type: array
- description: An array of product tag details.
- items:
- $ref: ./ProductTag.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product tags skipped when retrieving the product tags.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml
deleted file mode 100644
index 7a6196cb3b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypesListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of product types with pagination fields.
-required:
- - product_types
- - count
- - offset
- - limit
-properties:
- product_types:
- type: array
- description: An array of product types details.
- items:
- $ref: ./ProductType.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product types skipped when retrieving the product types.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml
deleted file mode 100644
index 5ead8a8fea..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteOptionRes.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-type: object
-description: The details of deleting a product's option.
-x-expanded-relations:
- field: product
- relations:
- - collection
- - images
- - options
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
-required:
- - option_id
- - object
- - deleted
- - product
-properties:
- option_id:
- type: string
- description: The ID of the deleted Product Option
- object:
- type: string
- description: The type of the object that was deleted.
- default: option
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
- product:
- description: Product details.
- $ref: ./PricedProduct.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml
deleted file mode 100644
index 4fc6532608..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteRes.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The details of deleting a product.
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Product.
- object:
- type: string
- description: The type of the object that was deleted.
- default: product
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml
deleted file mode 100644
index 46d801216c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsDeleteVariantRes.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-type: object
-description: The details of deleting a product's variant.
-x-expanded-relations:
- field: product
- relations:
- - collection
- - images
- - options
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
-required:
- - variant_id
- - object
- - deleted
- - product
-properties:
- variant_id:
- type: string
- description: The ID of the deleted Product Variant.
- object:
- type: string
- description: The type of the object that was deleted.
- default: product-variant
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
- product:
- description: Product details.
- $ref: ./PricedProduct.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml
deleted file mode 100644
index e841feb40a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListRes.yaml
+++ /dev/null
@@ -1,35 +0,0 @@
-type: object
-description: The list of products with pagination fields.
-x-expanded-relations:
- field: products
- relations:
- - collection
- - images
- - options
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
- totals:
- - variants.purchasable
-required:
- - products
- - count
- - offset
- - limit
-properties:
- products:
- type: array
- description: An array of products details.
- items:
- $ref: ./PricedProduct.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of products skipped when retrieving the products.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml
deleted file mode 100644
index b568306f84..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTagsRes.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-type: object
-description: The usage details of product tags.
-required:
- - tags
-properties:
- tags:
- description: An array of product tags details.
- type: array
- items:
- type: object
- required:
- - id
- - usage_count
- - value
- properties:
- id:
- description: The ID of the tag.
- type: string
- usage_count:
- description: The number of products that use this tag.
- type: string
- value:
- description: The value of the tag.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTypesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTypesRes.yaml
deleted file mode 100644
index fac5b6cfac..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListTypesRes.yaml
+++ /dev/null
@@ -1,9 +0,0 @@
-type: object
-required:
- - types
-properties:
- types:
- type: array
- description: An array of product types details.
- items:
- $ref: ./ProductType.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListVariantsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListVariantsRes.yaml
deleted file mode 100644
index e70bf99b9e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsListVariantsRes.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-type: object
-required:
- - variants
- - count
- - offset
- - limit
-properties:
- variants:
- type: array
- description: An array of product variants details.
- items:
- $ref: ./ProductVariant.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of product variants skipped when retrieving the product
- variants.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml
deleted file mode 100644
index 247e9e3725..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductsRes.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-type: object
-description: The product's details.
-x-expanded-relations:
- field: product
- relations:
- - collection
- - images
- - options
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
-required:
- - product
-properties:
- product:
- description: Product details.
- $ref: ./PricedProduct.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml
deleted file mode 100644
index 5bab265f39..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeyDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted publishable API key.
- object:
- type: string
- description: The type of the object that was deleted.
- default: publishable_api_key
- deleted:
- type: boolean
- description: Whether the publishable API key was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml
deleted file mode 100644
index 9d70064441..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListRes.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-type: object
-description: The list of publishable API keys with pagination fields.
-required:
- - publishable_api_keys
- - count
- - offset
- - limit
-properties:
- publishable_api_keys:
- type: array
- description: An array of publishable API keys details.
- items:
- $ref: ./PublishableApiKey.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of publishable API keys skipped when retrieving the publishable
- API keys.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml
deleted file mode 100644
index 1cfe709ec1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysListSalesChannelsRes.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The list of sales channel.
-required:
- - sales_channels
-properties:
- sales_channels:
- description: An array of sales channels details.
- type: array
- items:
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml
deleted file mode 100644
index e34ea5f2fe..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminPublishableApiKeysRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The publishable API key's details.
-required:
- - publishable_api_key
-properties:
- publishable_api_key:
- description: Publishable API key details.
- $ref: ./PublishableApiKey.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml
deleted file mode 100644
index df50b7eba4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The refund's details.
-required:
- - refund
-properties:
- refund:
- description: Refund details.
- $ref: ./Refund.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsDeleteRes.yaml
deleted file mode 100644
index 890f5414e2..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Region.
- object:
- type: string
- description: The type of the object that was deleted.
- default: region
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml
deleted file mode 100644
index 23f457049d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsListRes.yaml
+++ /dev/null
@@ -1,31 +0,0 @@
-type: object
-description: The list of regions with pagination fields.
-x-expanded-relations:
- field: regions
- relations:
- - countries
- - fulfillment_providers
- - payment_providers
- eager:
- - fulfillment_providers
- - payment_providers
-required:
- - regions
- - count
- - offset
- - limit
-properties:
- regions:
- type: array
- description: An array of regions details.
- items:
- $ref: ./Region.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of regions skipped when retrieving the regions.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml
deleted file mode 100644
index 6a710c9b74..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionsRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The region's details.
-x-expanded-relations:
- field: region
- relations:
- - countries
- - fulfillment_providers
- - payment_providers
- eager:
- - fulfillment_providers
- - payment_providers
-required:
- - region
-properties:
- region:
- description: Region details.
- $ref: ./Region.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsDeleteRes.yaml
deleted file mode 100644
index 7b10d15ecd..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Reservation.
- object:
- type: string
- description: The type of the object that was deleted.
- default: reservation
- deleted:
- type: boolean
- description: Whether or not the Reservation was deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml
deleted file mode 100644
index 8a9afebfba..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of reservations with pagination fields.
-required:
- - reservations
- - count
- - offset
- - limit
-properties:
- reservations:
- type: array
- description: An array of reservations details.
- items:
- $ref: ./ExtendedReservationItem.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of reservations skipped when retrieving the reservations.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml
deleted file mode 100644
index ab3cc2c88a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The reservation's details.
-required:
- - reservation
-properties:
- reservation:
- description: Reservation details.
- $ref: ./ReservationItemDTO.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml
deleted file mode 100644
index 3fa29d4bb2..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordRequest.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The details of the password reset request.
-required:
- - token
- - password
-properties:
- email:
- description: The User's email.
- type: string
- format: email
- token:
- description: The password-reset token generated when the password reset was requested.
- type: string
- password:
- description: The User's new password.
- type: string
- format: password
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml
deleted file mode 100644
index f2e5b0e6d5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminResetPasswordTokenRequest.yaml
+++ /dev/null
@@ -1,9 +0,0 @@
-type: object
-description: The details of the password reset token request.
-required:
- - email
-properties:
- email:
- description: The User's email.
- type: string
- format: email
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml
deleted file mode 100644
index 424e73dbab..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted return reason
- object:
- type: string
- description: The type of the object that was deleted.
- default: return_reason
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml
deleted file mode 100644
index 79ddc132d1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsListRes.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-description: The list of return reasons.
-x-expanded-relations:
- field: return_reasons
- relations:
- - parent_return_reason
- - return_reason_children
-required:
- - return_reasons
-properties:
- return_reasons:
- type: array
- description: The list of return reasons.
- items:
- $ref: ./ReturnReason.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml
deleted file mode 100644
index 73c0b9a260..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonsRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The return reason's details.
-x-expanded-relations:
- field: return_reason
- relations:
- - parent_return_reason
- - return_reason_children
-required:
- - return_reason
-properties:
- return_reason:
- description: The return reason's details.
- $ref: ./ReturnReason.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml
deleted file mode 100644
index 5a9946f7a4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsCancelRes.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-type: object
-description: The associated order's details.
-x-expanded-relations:
- field: order
- relations:
- - billing_address
- - claims
- - claims.additional_items
- - claims.additional_items.variant
- - claims.claim_items
- - claims.claim_items.images
- - claims.claim_items.item
- - claims.fulfillments
- - claims.fulfillments.tracking_links
- - claims.return_order
- - claims.return_order.shipping_method
- - claims.return_order.shipping_method.tax_lines
- - claims.shipping_address
- - claims.shipping_methods
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.items
- - fulfillments.tracking_links
- - gift_card_transactions
- - gift_cards
- - items
- - payments
- - refunds
- - region
- - returns
- - returns.items
- - returns.items.reason
- - returns.shipping_method
- - returns.shipping_method.tax_lines
- - shipping_address
- - shipping_methods
- - swaps
- - swaps.additional_items
- - swaps.additional_items.variant
- - swaps.fulfillments
- - swaps.fulfillments.tracking_links
- - swaps.payment
- - swaps.return_order
- - swaps.return_order.shipping_method
- - swaps.return_order.shipping_method.tax_lines
- - swaps.shipping_address
- - swaps.shipping_methods
- - swaps.shipping_methods.tax_lines
-required:
- - order
-properties:
- order:
- description: Order details.
- $ref: ./Order.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml
deleted file mode 100644
index e40254eb57..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsListRes.yaml
+++ /dev/null
@@ -1,27 +0,0 @@
-type: object
-description: The list of returns with pagination fields.
-x-expanded-relation:
- field: returns
- relations:
- - order
- - swap
-required:
- - returns
- - count
- - offset
- - limit
-properties:
- returns:
- type: array
- description: An array of returns details.
- items:
- $ref: ./Return.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of returns skipped when retrieving the returns.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml
deleted file mode 100644
index 07642af666..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnsRes.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-type: object
-description: The return's details.
-x-expanded-relation:
- field: return
- relations:
- - swap
-required:
- - return
-properties:
- return:
- description: Return details.
- $ref: ./Return.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsDeleteLocationRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsDeleteLocationRes.yaml
deleted file mode 100644
index 6d12dbbcec..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsDeleteLocationRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the removed stock location from a sales channel
- object:
- type: string
- description: The type of the object that was removed.
- default: stock-location
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsDeleteRes.yaml
deleted file mode 100644
index c953197736..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted sales channel
- object:
- type: string
- description: The type of the object that was deleted.
- default: sales-channel
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml
deleted file mode 100644
index 2bc137e1c7..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of sales channels with pagination fields.
-required:
- - sales_channels
- - count
- - offset
- - limit
-properties:
- sales_channels:
- type: array
- description: An array of sales channels details.
- items:
- $ref: ./SalesChannel.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of items skipped before the returned results
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml
deleted file mode 100644
index 0fb4eee0f8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The sales channel's details.
-required:
- - sales_channel
-properties:
- sales_channel:
- description: Sales Channel's details.
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsDeleteRes.yaml
deleted file mode 100644
index e734f894f8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: shipping-option
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml
deleted file mode 100644
index db1ab6f304..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsListRes.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-type: object
-description: The list of shipping options with pagination fields.
-x-expanded-relations:
- field: shipping_options
- relations:
- - profile
- - region
- - requirements
- eager:
- - region.fulfillment_providers
- - region.payment_providers
-required:
- - shipping_options
- - count
- - offset
- - limit
-properties:
- shipping_options:
- type: array
- description: An array of shipping options details.
- items:
- $ref: ./ShippingOption.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of shipping options skipped when retrieving the shipping
- options.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml
deleted file mode 100644
index 005b91abb2..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionsRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The shipping option's details.
-x-expanded-relations:
- field: shipping_option
- relations:
- - profile
- - region
- - requirements
- eager:
- - region.fulfillment_providers
- - region.payment_providers
-required:
- - shipping_option
-properties:
- shipping_option:
- description: Shipping option details.
- $ref: ./ShippingOption.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml
deleted file mode 100644
index 6026c70ce3..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesListRes.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The list of shipping profiles.
-required:
- - shipping_profiles
-properties:
- shipping_profiles:
- type: array
- description: An array of shipping profiles details.
- items:
- $ref: ./ShippingProfile.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml
deleted file mode 100644
index 78ef8ae7d8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfilesRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The shipping profile's details.
-x-expanded-relations:
- field: shipping_profile
- relations:
- - products
- - shipping_options
-required:
- - shipping_profile
-properties:
- shipping_profile:
- description: Shipping profile details.
- $ref: ./ShippingProfile.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsDeleteRes.yaml
deleted file mode 100644
index 6e5d17e47b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Stock Location.
- object:
- type: string
- description: The type of the object that was deleted.
- default: stock_location
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml
deleted file mode 100644
index f8fcbd8e39..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of stock locations with pagination fields.
-required:
- - stock_locations
- - count
- - offset
- - limit
-properties:
- stock_locations:
- type: array
- description: The list of stock locations.
- items:
- $ref: ./StockLocationExpandedDTO.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of stock locations skipped when retrieving the stock locations.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml
deleted file mode 100644
index 2720159825..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The stock location's details.
-required:
- - stock_location
-properties:
- stock_location:
- description: Stock location details.
- $ref: ./StockLocationExpandedDTO.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml
deleted file mode 100644
index ca9362c05e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminStoresRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The store's details.
-required:
- - store
-properties:
- store:
- description: Store details.
- $ref: ./Store.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml
deleted file mode 100644
index 36cc47821b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of swaps with pagination fields.
-required:
- - swaps
- - count
- - offset
- - limit
-properties:
- swaps:
- type: array
- description: An array of swaps details.
- items:
- $ref: ./Swap.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of swaps skipped when retrieving the swaps.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml
deleted file mode 100644
index d0afd6fcc5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminSwapsRes.yaml
+++ /dev/null
@@ -1,26 +0,0 @@
-type: object
-description: The swap's details.
-x-expanded-relations:
- field: swap
- relations:
- - additional_items
- - additional_items.adjustments
- - cart
- - cart.items
- - cart.items.adjustments
- - cart.items.variant
- - fulfillments
- - order
- - payment
- - return_order
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
- - shipping_methods.shipping_option
-required:
- - swap
-properties:
- swap:
- description: Swap details.
- $ref: ./Swap.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml
deleted file mode 100644
index ffd5d3e4a5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxProvidersList.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The list of tax providers in a store.
-required:
- - tax_providers
-properties:
- tax_providers:
- type: array
- description: An array of tax providers details.
- items:
- $ref: ./TaxProvider.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesDeleteRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesDeleteRes.yaml
deleted file mode 100644
index df9ba39e4d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesDeleteRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - id
- - object
- - deleted
-properties:
- id:
- type: string
- description: The ID of the deleted Shipping Option.
- object:
- type: string
- description: The type of the object that was deleted.
- default: tax-rate
- deleted:
- type: boolean
- description: Whether or not the items were deleted.
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml
deleted file mode 100644
index 576c38f3b4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of tax rates with pagination fields.
-required:
- - tax_rates
- - count
- - offset
- - limit
-properties:
- tax_rates:
- type: array
- description: An array of tax rate details.
- items:
- $ref: ./TaxRate.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of tax rates to skip when retrieving the tax rates.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml
deleted file mode 100644
index 3d45207088..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRatesRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The tax rate's details.
-required:
- - tax_rate
-properties:
- tax_rate:
- description: Tax rate details.
- $ref: ./TaxRate.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml
deleted file mode 100644
index 61b6570e26..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePaymentCollectionsReq.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The details to update of the payment collection.
-properties:
- description:
- description: A description to create or update the payment collection.
- type: string
- metadata:
- description: A set of key-value pairs to hold additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml
index de06280aed..cf5247c937 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUserRequest.yaml
@@ -1,27 +1,18 @@
type: object
+description: SUMMARY
+x-schemaName: AdminUpdateUserRequest
+required:
+ - avatar_url
properties:
first_name:
- description: The first name of the User.
type: string
+ title: first_name
+ description: The user's first name.
last_name:
- description: The last name of the User.
type: string
- role:
- description: >-
- The role assigned to the user. These roles don't provide any different
- privileges.
+ title: last_name
+ description: The user's last name.
+ avatar_url:
type: string
- enum:
- - admin
- - member
- - developer
- api_token:
- description: The API token of the User.
- type: string
- metadata:
- description: An optional set of key-value pairs with additional information.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
+ title: avatar_url
+ description: The user's avatar url.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml
deleted file mode 100644
index d3cfb785dc..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsDownloadUrlRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The download URL details.
-required:
- - download_url
-properties:
- download_url:
- description: The Download URL of the file
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml
deleted file mode 100644
index 556b721195..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-type: object
-description: The list of uploaded files.
-required:
- - uploads
-properties:
- uploads:
- type: array
- description: Uploaded files details.
- items:
- type: object
- required:
- - url
- - key
- properties:
- url:
- description: The URL of the uploaded file.
- type: string
- format: uri
- key:
- description: >-
- The key of the file that is identifiable by the file service. It can
- be used later to retrieve or manipulate the file.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml
deleted file mode 100644
index a5f5bcc495..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The user's details.
-required:
- - user
-properties:
- user:
- description: User details.
- $ref: ./User.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml
deleted file mode 100644
index 689c7d6608..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminUsersListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of users.
-required:
- - users
- - count
- - offset
- - limit
-properties:
- users:
- type: array
- description: An array of users details.
- items:
- $ref: ./User.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of users skipped when retrieving the users.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml
deleted file mode 100644
index e07d1e752d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsListRes.yaml
+++ /dev/null
@@ -1,32 +0,0 @@
-type: object
-description: The list of variants with pagination fields.
-x-expanded-relations:
- field: variants
- relations:
- - options
- - prices
- - product
- totals:
- - purchasable
-required:
- - variants
- - count
- - offset
- - limit
-properties:
- variants:
- type: array
- description: An array of product variant details.
- items:
- $ref: ./PricedVariant.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of product variants skipped when retrieving the product
- variants.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml
deleted file mode 100644
index ce92e0c8c0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/AdminVariantsRes.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: The product variant's details.
-x-expanded-relations:
- field: variant
- relations:
- - options
- - prices
- - product
-required:
- - variant
-properties:
- variant:
- description: Product variant's details.
- $ref: ./PricedVariant.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/ApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethod.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/ApplicationMethod.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/ApplicationMethod.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/ApplicationMethodsMethodPostReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/BatchJob.yaml b/www/apps/api-reference/specs/admin/components/schemas/BatchJob.yaml
deleted file mode 100644
index a70156fe2c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/BatchJob.yaml
+++ /dev/null
@@ -1,171 +0,0 @@
-title: Batch Job
-description: >-
- A Batch Job indicates an asynchronus task stored in the Medusa backend. Its
- status determines whether it has been executed or not.
-type: object
-required:
- - canceled_at
- - completed_at
- - confirmed_at
- - context
- - created_at
- - created_by
- - deleted_at
- - dry_run
- - failed_at
- - id
- - pre_processed_at
- - processing_at
- - result
- - status
- - type
- - updated_at
-properties:
- id:
- description: The unique identifier for the batch job.
- type: string
- example: batch_01G8T782965PYFG0751G0Z38B4
- type:
- description: The type of batch job.
- type: string
- enum:
- - product-import
- - product-export
- status:
- description: The status of the batch job.
- type: string
- enum:
- - created
- - pre_processed
- - confirmed
- - processing
- - completed
- - canceled
- - failed
- default: created
- created_by:
- description: The unique identifier of the user that created the batch job.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- created_by_user:
- description: The details of the user that created the batch job.
- x-expandable: created_by_user
- nullable: true
- $ref: ./User.yaml
- context:
- description: >-
- The context of the batch job, the type of the batch job determines what
- the context should contain.
- nullable: true
- type: object
- example:
- shape:
- prices:
- - region: null
- currency_code: eur
- dynamicImageColumnCount: 4
- dynamicOptionColumnCount: 2
- list_config:
- skip: 0
- take: 50
- order:
- created_at: DESC
- relations:
- - variants
- - variant.prices
- - images
- dry_run:
- description: Specify if the job must apply the modifications or not.
- type: boolean
- default: false
- result:
- description: The result of the batch job.
- nullable: true
- allOf:
- - type: object
- example: {}
- - type: object
- properties:
- count:
- type: number
- advancement_count:
- type: number
- progress:
- type: number
- errors:
- type: object
- properties:
- message:
- type: string
- code:
- oneOf:
- - type: string
- - type: number
- err:
- type: array
- stat_descriptors:
- type: object
- properties:
- key:
- type: string
- name:
- type: string
- message:
- type: string
- file_key:
- type: string
- file_size:
- type: number
- example:
- errors:
- - err: []
- code: unknown
- message: Method not implemented.
- stat_descriptors:
- - key: product-export-count
- name: Product count to export
- message: There will be 8 products exported by this action
- pre_processed_at:
- description: The date from which the job has been pre-processed.
- nullable: true
- type: string
- format: date-time
- processing_at:
- description: The date the job is processing at.
- nullable: true
- type: string
- format: date-time
- confirmed_at:
- description: The date when the confirmation has been done.
- nullable: true
- type: string
- format: date-time
- completed_at:
- description: The date of the completion.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date of the concellation.
- nullable: true
- type: string
- format: date-time
- failed_at:
- description: The date when the job failed.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was last updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/Campaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/Campaign.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/Campaign.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/Campaign.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CampaignBudget.yaml b/www/apps/api-reference/specs/admin/components/schemas/CampaignBudget.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CampaignBudget.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CampaignBudget.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Cart.yaml b/www/apps/api-reference/specs/admin/components/schemas/Cart.yaml
deleted file mode 100644
index 4283873041..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Cart.yaml
+++ /dev/null
@@ -1,243 +0,0 @@
-title: Cart
-description: >-
- A cart represents a virtual shopping bag. It can be used to complete an order,
- a swap, or a claim.
-type: object
-required:
- - billing_address_id
- - completed_at
- - context
- - created_at
- - customer_id
- - deleted_at
- - email
- - id
- - idempotency_key
- - metadata
- - payment_authorized_at
- - payment_id
- - payment_session
- - region_id
- - shipping_address_id
- - type
- - updated_at
-properties:
- id:
- description: The cart's ID
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- email:
- description: The email associated with the cart
- nullable: true
- type: string
- format: email
- billing_address_id:
- description: The billing address's ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the cart.
- x-expandable: billing_address
- nullable: true
- $ref: ./Address.yaml
- shipping_address_id:
- description: The shipping address's ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address associated with the cart.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- items:
- description: The line items added to the cart.
- type: array
- x-expandable: items
- items:
- $ref: ./LineItem.yaml
- region_id:
- description: The region's ID
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region associated with the cart.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- discounts:
- description: An array of details of all discounts applied to the cart.
- type: array
- x-expandable: discounts
- items:
- $ref: ./Discount.yaml
- gift_cards:
- description: An array of details of all gift cards applied to the cart.
- type: array
- x-expandable: gift_cards
- items:
- $ref: ./GiftCard.yaml
- customer_id:
- description: The customer's ID
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer the cart belongs to.
- x-expandable: customer
- nullable: true
- type: object
- payment_session:
- description: The details of the selected payment session in the cart.
- x-expandable: payment_session
- nullable: true
- type: object
- payment_sessions:
- description: The details of all payment sessions created on the cart.
- type: array
- x-expandable: payment_sessions
- items:
- type: object
- payment_id:
- description: The payment's ID if available
- nullable: true
- type: string
- example: pay_01G8ZCC5W42ZNY842124G7P5R9
- payment:
- description: The details of the payment associated with the cart.
- nullable: true
- x-expandable: payment
- type: object
- shipping_methods:
- description: The details of the shipping methods added to the cart.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- type:
- description: The cart's type.
- type: string
- enum:
- - default
- - swap
- - draft_order
- - payment_link
- - claim
- default: default
- completed_at:
- description: The date with timezone at which the cart was completed.
- nullable: true
- type: string
- format: date-time
- payment_authorized_at:
- description: The date with timezone at which the payment was authorized.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a cart in case
- of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- context:
- description: The context of the cart which can include info like IP or user agent.
- nullable: true
- type: object
- example:
- ip: '::1'
- user_agent: PostmanRuntime/7.29.2
- sales_channel_id:
- description: The sales channel ID the cart is associated with.
- nullable: true
- type: string
- example: null
- sales_channel:
- description: The details of the sales channel associated with the cart.
- nullable: true
- x-expandable: sales_channel
- $ref: ./SalesChannel.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- shipping_total:
- description: The total of shipping
- type: integer
- example: 1000
- discount_total:
- description: The total of discount rounded
- type: integer
- example: 800
- raw_discount_total:
- description: The total of discount
- type: integer
- example: 800
- item_tax_total:
- description: The total of items with taxes
- type: integer
- example: 8000
- shipping_tax_total:
- description: The total of shipping with taxes
- type: integer
- example: 1000
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- refunded_total:
- description: >-
- The total amount refunded if the order associated with this cart is
- returned.
- type: integer
- example: 0
- total:
- description: The total amount of the cart
- type: integer
- example: 8200
- subtotal:
- description: The subtotal of the cart
- type: integer
- example: 8000
- refundable_amount:
- description: The amount that can be refunded
- type: integer
- example: 8200
- gift_card_total:
- description: The total of gift cards
- type: integer
- example: 0
- gift_card_tax_total:
- description: The total of gift cards with taxes
- type: integer
- example: 0
- sales_channels:
- description: The associated sales channels.
- type: array
- nullable: true
- x-expandable: sales_channels
- items:
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ClaimImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/ClaimImage.yaml
deleted file mode 100644
index 7b64e6be1d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ClaimImage.yaml
+++ /dev/null
@@ -1,51 +0,0 @@
-title: Claim Image
-description: The details of an image attached to a claim.
-type: object
-required:
- - claim_item_id
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - url
-properties:
- id:
- description: The claim image's ID
- type: string
- example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
- claim_item_id:
- description: The ID of the claim item associated with the image
- type: string
- claim_item:
- description: The details of the claim item this image is associated with.
- nullable: true
- x-expandable: claim_item
- type: object
- url:
- description: The URL of the image
- type: string
- format: uri
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ClaimItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/ClaimItem.yaml
deleted file mode 100644
index 6d9a8a9b67..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ClaimItem.yaml
+++ /dev/null
@@ -1,106 +0,0 @@
-title: Claim Item
-description: >-
- A claim item is an item created as part of a claim. It references an item in
- the order that should be exchanged or refunded.
-type: object
-required:
- - claim_order_id
- - created_at
- - deleted_at
- - id
- - item_id
- - metadata
- - note
- - quantity
- - reason
- - updated_at
- - variant_id
-properties:
- id:
- description: The claim item's ID
- type: string
- example: citm_01G8ZH853Y6TFXWPG5EYE81X63
- images:
- description: The claim images that are attached to the claim item.
- type: array
- x-expandable: images
- items:
- $ref: ./ClaimImage.yaml
- claim_order_id:
- description: The ID of the claim this item is associated with.
- type: string
- claim_order:
- description: The details of the claim this item belongs to.
- x-expandable: claim_order
- nullable: true
- type: object
- item_id:
- description: The ID of the line item that the claim item refers to.
- type: string
- example: item_01G8ZM25TN49YV9EQBE2NC27KC
- item:
- description: >-
- The details of the line item in the original order that this claim item
- refers to.
- x-expandable: item
- nullable: true
- $ref: ./LineItem.yaml
- variant_id:
- description: The ID of the product variant that is claimed.
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: >-
- The details of the product variant to potentially replace the item in the
- original order.
- x-expandable: variant
- nullable: true
- $ref: ./ProductVariant.yaml
- reason:
- description: The reason for the claim
- type: string
- enum:
- - missing_item
- - wrong_item
- - production_failure
- - other
- note:
- description: An optional note about the claim, for additional information
- nullable: true
- type: string
- example: I don't like it.
- quantity:
- description: >-
- The quantity of the item that is being claimed; must be less than or equal
- to the amount purchased in the original order.
- type: integer
- example: 1
- tags:
- description: User defined tags for easy filtering and grouping.
- type: array
- x-expandable: tags
- items:
- $ref: ./ClaimTag.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ClaimOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/ClaimOrder.yaml
deleted file mode 100644
index e3de8e9d1b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ClaimOrder.yaml
+++ /dev/null
@@ -1,157 +0,0 @@
-title: Claim
-description: >-
- A Claim represents a group of faulty or missing items. It consists of claim
- items that refer to items in the original order that should be replaced or
- refunded. It also includes details related to shipping and fulfillment.
-type: object
-required:
- - canceled_at
- - created_at
- - deleted_at
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - order_id
- - payment_status
- - refund_amount
- - shipping_address_id
- - type
- - updated_at
-properties:
- id:
- description: The claim's ID
- type: string
- example: claim_01G8ZH853Y6TFXWPG5EYE81X63
- type:
- description: The claim's type
- type: string
- enum:
- - refund
- - replace
- payment_status:
- description: The status of the claim's payment
- type: string
- enum:
- - na
- - not_refunded
- - refunded
- default: na
- fulfillment_status:
- description: The claim's fulfillment status
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- default: not_fulfilled
- claim_items:
- description: The details of the items that should be replaced or refunded.
- type: array
- x-expandable: claim_items
- items:
- $ref: ./ClaimItem.yaml
- additional_items:
- description: >-
- The details of the new items to be shipped when the claim's type is
- `replace`
- type: array
- x-expandable: additional_items
- items:
- $ref: ./LineItem.yaml
- order_id:
- description: The ID of the order that the claim comes from.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that this claim was created for.
- x-expandable: order
- nullable: true
- type: object
- return_order:
- description: >-
- The details of the return associated with the claim if the claim's type is
- `replace`.
- x-expandable: return_order
- nullable: true
- type: object
- shipping_address_id:
- description: The ID of the address that the new items should be shipped to
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the address that new items should be shipped to.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- shipping_methods:
- description: >-
- The details of the shipping methods that the claim order will be shipped
- with.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- fulfillments:
- description: The fulfillments of the new items to be shipped
- type: array
- x-expandable: fulfillments
- items:
- type: object
- refund_amount:
- description: The amount that will be refunded in conjunction with the claim
- nullable: true
- type: integer
- example: 1000
- canceled_at:
- description: The date with timezone at which the claim was canceled.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- no_notification:
- description: >-
- Flag for describing whether or not notifications related to this should be
- send.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the cart
- associated with the claim in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ClaimTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/ClaimTag.yaml
deleted file mode 100644
index 4c8924448f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ClaimTag.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Claim Tag
-description: >-
- Claim Tags are user defined tags that can be assigned to claim items for easy
- filtering and grouping.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
-properties:
- id:
- description: The claim tag's ID
- type: string
- example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4
- value:
- description: The value that the claim tag holds
- type: string
- example: Damaged
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Country.yaml b/www/apps/api-reference/specs/admin/components/schemas/Country.yaml
deleted file mode 100644
index cfa712f0ff..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Country.yaml
+++ /dev/null
@@ -1,58 +0,0 @@
-title: Country
-description: Country details
-type: object
-required:
- - display_name
- - id
- - iso_2
- - iso_3
- - name
- - num_code
- - region_id
-properties:
- id:
- description: The country's ID
- type: string
- example: 109
- iso_2:
- description: The 2 character ISO code of the country in lower case
- type: string
- example: it
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- iso_3:
- description: The 2 character ISO code of the country in lower case
- type: string
- example: ita
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements
- description: See a list of codes.
- num_code:
- description: The numerical ISO code for the country.
- type: string
- example: 380
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements
- description: See a list of codes.
- name:
- description: The normalized country name in upper case.
- type: string
- example: ITALY
- display_name:
- description: The country name appropriate for display.
- type: string
- example: Italy
- region_id:
- description: The region ID this country is associated with.
- nullable: true
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region the country is associated with.
- x-expandable: region
- nullable: true
- type: object
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateAddress.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateApiKey.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateApiKey.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateApiKey.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateApplicationMethod.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateApplicationMethod.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateApplicationMethod.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCampaign.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCampaign.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCampaign.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCampaign.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCampaignBudget.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCampaignBudget.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCampaignBudget.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCampaignBudget.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCartAddress.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCartCreateLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCartCreateLineItem.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCartWorkflowInput.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCustomer.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCustomer.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCustomer.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCustomerAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCustomerAddress.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCustomerAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCustomerGroup.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateCustomerGroup.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateCustomerGroup.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateDefaultTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateDefaultTaxRate.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateDefaultTaxRate.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateDefaultTaxRate.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateInvite.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateInvite.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateInvite.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateInvite.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProduct.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProduct.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProduct.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductCollection.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductCollection.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProductCollection.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductOption.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductOption.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProductOption.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductTag.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductTag.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProductTag.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductType.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductType.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProductType.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariant.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductVariant.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProductVariant.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductVariantOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateProductVariantOption.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateProductVariantOption.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateProductVariantOption.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreatePromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreatePromotion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreatePromotion.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreatePromotion.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreatePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreatePromotionRule.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreatePromotionRule.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreatePromotionRule.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateRegion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateRegion.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateRegion.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateStockLocationInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateStockLocationInput.yaml
deleted file mode 100644
index 6a8d7255f5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/CreateStockLocationInput.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-title: Create Stock Location Input
-description: Represents the Input to create a Stock Location
-type: object
-required:
- - name
-properties:
- name:
- type: string
- description: The stock location name
- address_id:
- type: string
- description: The Stock location address ID
- address:
- description: Stock location address object
- allOf:
- - $ref: ./StockLocationAddressInput.yaml
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateTaxRateRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateTaxRateRule.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateTaxRateRule.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateTaxRateRule.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CreateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CreateUser.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CreateUser.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Currency.yaml b/www/apps/api-reference/specs/admin/components/schemas/Currency.yaml
deleted file mode 100644
index adfb21705c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Currency.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-title: Currency
-description: Currency
-type: object
-required:
- - code
- - name
- - symbol
- - symbol_native
-properties:
- code:
- description: The 3 character ISO code for the currency.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- symbol:
- description: The symbol used to indicate the currency.
- type: string
- example: $
- symbol_native:
- description: The native symbol used to indicate the currency.
- type: string
- example: $
- name:
- description: The written name of the currency
- type: string
- example: US Dollar
- includes_tax:
- description: Whether the currency prices include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomShippingOption.yaml
deleted file mode 100644
index 472d04273b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/CustomShippingOption.yaml
+++ /dev/null
@@ -1,68 +0,0 @@
-title: Custom Shipping Option
-description: >-
- Custom Shipping Options are overridden Shipping Options. Admins can attach a
- Custom Shipping Option to a cart in order to set a custom price for a
- particular Shipping Option.
-type: object
-required:
- - cart_id
- - created_at
- - deleted_at
- - id
- - metadata
- - price
- - shipping_option_id
- - updated_at
-properties:
- id:
- description: The custom shipping option's ID
- type: string
- example: cso_01G8X99XNB77DMFBJFWX6DN9V9
- price:
- description: >-
- The custom price set that will override the shipping option's original
- price
- type: integer
- example: 1000
- shipping_option_id:
- description: The ID of the Shipping Option that the custom shipping option overrides
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the overridden shipping options.
- x-expandable: shipping_option
- nullable: true
- $ref: ./ShippingOption.yaml
- cart_id:
- description: The ID of the Cart that the custom shipping option is attached to
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart this shipping option belongs to.
- x-expandable: cart
- nullable: true
- $ref: ./Cart.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Customer.yaml b/www/apps/api-reference/specs/admin/components/schemas/Customer.yaml
index ecc9c83ee4..063a4ff87a 100644
--- a/www/apps/api-reference/specs/admin/components/schemas/Customer.yaml
+++ b/www/apps/api-reference/specs/admin/components/schemas/Customer.yaml
@@ -1,94 +1,87 @@
-title: Customer
-description: A customer can make purchases in your store and manage their profile.
type: object
-required:
- - billing_address_id
- - created_at
- - deleted_at
- - email
- - first_name
- - has_account
- - id
- - last_name
- - metadata
- - phone
- - updated_at
+description: The context's customer.
+x-schemaName: Customer
properties:
id:
- description: The customer's ID
type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+ title: id
+ description: The customer's ID.
email:
- description: The customer's email
type: string
+ title: email
+ description: The customer's email.
format: email
+ default_billing_address_id:
+ type: string
+ title: default_billing_address_id
+ description: The customer's default billing address id.
+ default_shipping_address_id:
+ type: string
+ title: default_shipping_address_id
+ description: The customer's default shipping address id.
+ company_name:
+ type: string
+ title: company_name
+ description: The customer's company name.
first_name:
- description: The customer's first name
- nullable: true
type: string
- example: Arno
+ title: first_name
+ description: The customer's first name.
last_name:
- description: The customer's last name
- nullable: true
type: string
- example: Willms
- billing_address_id:
- description: The customer's billing address ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the customer.
- x-expandable: billing_address
- nullable: true
- $ref: ./Address.yaml
- shipping_addresses:
- description: The details of the shipping addresses associated with the customer.
+ title: last_name
+ description: The customer's last name.
+ addresses:
type: array
- x-expandable: shipping_addresses
- items:
- $ref: ./Address.yaml
- phone:
- description: The customer's phone number
- nullable: true
- type: string
- example: 16128234334802
- has_account:
- description: Whether the customer has an account or not
- type: boolean
- default: false
- orders:
- description: The details of the orders this customer placed.
- type: array
- x-expandable: orders
+ description: The customer's addresses.
items:
type: object
+ description: The address's addresses.
+ x-schemaName: CustomerAddress
+ properties: {}
+ phone:
+ type: string
+ title: phone
+ description: The customer's phone.
groups:
- description: The customer groups the customer belongs to.
type: array
- x-expandable: groups
+ description: The customer's groups.
items:
- $ref: ./CustomerGroup.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
+ type: object
+ description: The group's groups.
+ properties: {}
metadata:
- description: An optional key-value map with additional details
- nullable: true
type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
+ description: The customer's metadata.
+ properties: {}
+ created_by:
+ type: string
+ title: created_by
+ description: The customer's created by.
+ deleted_at:
+ oneOf:
+ - type: string
+ title: deleted_at
+ description: The customer's deleted at.
+ - type: string
+ title: deleted_at
+ description: The customer's deleted at.
+ format: date-time
+ created_at:
+ oneOf:
+ - type: string
+ title: created_at
+ description: The customer's created at.
+ - type: string
+ title: created_at
+ description: The customer's created at.
+ format: date-time
+ updated_at:
+ oneOf:
+ - type: string
+ title: updated_at
+ description: The customer's updated at.
+ - type: string
+ title: updated_at
+ description: The customer's updated at.
+ format: date-time
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CustomerAddress.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CustomerAddress.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroup.yaml
deleted file mode 100644
index a572493cad..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroup.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-title: Customer Group
-description: >-
- A customer group that can be used to organize customers into groups of similar
- traits.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - name
- - updated_at
-properties:
- id:
- description: The customer group's ID
- type: string
- example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
- name:
- description: The name of the customer group
- type: string
- example: VIP
- customers:
- description: The details of the customers that belong to the customer group.
- type: array
- x-expandable: customers
- items:
- type: object
- price_lists:
- description: The price lists that are associated with the customer group.
- type: array
- x-expandable: price_lists
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CustomerGroupUpdatableFields.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupUpdatableFields.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CustomerGroupUpdatableFields.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CustomerGroupUpdatableFields.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CustomerGroupsBatchCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupsBatchCustomer.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CustomerGroupsBatchCustomer.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CustomerGroupsBatchCustomer.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/CustomerUpdatableFields.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerUpdatableFields.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/CustomerUpdatableFields.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/CustomerUpdatableFields.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DecoratedInventoryItemDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/DecoratedInventoryItemDTO.yaml
deleted file mode 100644
index a3b200f6e9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DecoratedInventoryItemDTO.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-type: object
-allOf:
- - $ref: ./InventoryItemDTO.yaml
- - type: object
- required:
- - stocked_quantity
- - reserved_quantity
- properties:
- location_levels:
- type: array
- description: An array of location level details
- items:
- $ref: ./InventoryLevelDTO.yaml
- variants:
- type: array
- description: An array of product variant details
- items:
- $ref: ./ProductVariant.yaml
- stocked_quantity:
- type: number
- description: The total quantity of the item in stock across levels
- reserved_quantity:
- type: number
- description: The total quantity of the item available across levels
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Discount.yaml b/www/apps/api-reference/specs/admin/components/schemas/Discount.yaml
deleted file mode 100644
index 796477999f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Discount.yaml
+++ /dev/null
@@ -1,121 +0,0 @@
-title: Discount
-description: A discount can be applied to a cart for promotional purposes.
-type: object
-required:
- - code
- - created_at
- - deleted_at
- - ends_at
- - id
- - is_disabled
- - is_dynamic
- - metadata
- - parent_discount_id
- - rule_id
- - starts_at
- - updated_at
- - usage_count
- - usage_limit
- - valid_duration
-properties:
- id:
- description: The discount's ID
- type: string
- example: disc_01F0YESMW10MGHWJKZSDDMN0VN
- code:
- description: >-
- A unique code for the discount - this will be used by the customer to
- apply the discount
- type: string
- example: 10DISC
- is_dynamic:
- description: >-
- A flag to indicate if multiple instances of the discount can be generated.
- I.e. for newsletter discounts
- type: boolean
- example: false
- rule_id:
- description: >-
- The ID of the discount rule that defines how the discount will be applied
- to a cart.
- nullable: true
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- rule:
- description: >-
- The details of the discount rule that defines how the discount will be
- applied to a cart..
- x-expandable: rule
- nullable: true
- $ref: ./DiscountRule.yaml
- is_disabled:
- description: >-
- Whether the Discount has been disabled. Disabled discounts cannot be
- applied to carts
- type: boolean
- example: false
- parent_discount_id:
- description: >-
- The Discount that the discount was created from. This will always be a
- dynamic discount
- nullable: true
- type: string
- example: disc_01G8ZH853YPY9B94857DY91YGW
- parent_discount:
- description: The details of the parent discount that this discount was created from.
- x-expandable: parent_discount
- nullable: true
- type: object
- starts_at:
- description: The time at which the discount can be used.
- type: string
- format: date-time
- ends_at:
- description: The time at which the discount can no longer be used.
- nullable: true
- type: string
- format: date-time
- valid_duration:
- description: Duration the discount runs between
- nullable: true
- type: string
- example: P3Y6M4DT12H30M5S
- regions:
- description: The details of the regions in which the Discount can be used.
- type: array
- x-expandable: regions
- items:
- $ref: ./Region.yaml
- usage_limit:
- description: The maximum number of times that a discount can be used.
- nullable: true
- type: integer
- example: 100
- usage_count:
- description: The number of times a discount has been used.
- type: integer
- example: 50
- default: 0
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountCondition.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountCondition.yaml
deleted file mode 100644
index 4652b43d56..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountCondition.yaml
+++ /dev/null
@@ -1,105 +0,0 @@
-title: Discount Condition
-description: Holds rule conditions for when a discount is applicable
-type: object
-required:
- - created_at
- - deleted_at
- - discount_rule_id
- - id
- - metadata
- - operator
- - type
- - updated_at
-properties:
- id:
- description: The discount condition's ID
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- type:
- description: >-
- The type of the condition. The type affects the available resources
- associated with the condition. For example, if the type is `products`,
- that means the `products` relation will hold the products associated with
- this condition and other relations will be empty.
- type: string
- enum:
- - products
- - product_types
- - product_collections
- - product_tags
- - customer_groups
- operator:
- description: >-
- The operator of the condition. `in` indicates that discountable resources
- are within the specified resources. `not_in` indicates that discountable
- resources are everything but the specified resources.
- type: string
- enum:
- - in
- - not_in
- discount_rule_id:
- description: The ID of the discount rule associated with the condition
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- discount_rule:
- description: The details of the discount rule associated with the condition.
- x-expandable: discount_rule
- nullable: true
- $ref: ./DiscountRule.yaml
- products:
- description: products associated with this condition if `type` is `products`.
- type: array
- x-expandable: products
- items:
- $ref: ./Product.yaml
- product_types:
- description: Product types associated with this condition if `type` is `product_types`.
- type: array
- x-expandable: product_types
- items:
- $ref: ./ProductType.yaml
- product_tags:
- description: Product tags associated with this condition if `type` is `product_tags`.
- type: array
- x-expandable: product_tags
- items:
- $ref: ./ProductTag.yaml
- product_collections:
- description: >-
- Product collections associated with this condition if `type` is
- `product_collections`.
- type: array
- x-expandable: product_collections
- items:
- $ref: ./ProductCollection.yaml
- customer_groups:
- description: >-
- Customer groups associated with this condition if `type` is
- `customer_groups`.
- type: array
- x-expandable: customer_groups
- items:
- $ref: ./CustomerGroup.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionCustomerGroup.yaml
deleted file mode 100644
index 2f55e79142..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionCustomerGroup.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Product Tag Discount Condition
-description: Associates a discount condition with a customer group
-type: object
-required:
- - condition_id
- - created_at
- - customer_group_id
- - metadata
- - updated_at
-properties:
- customer_group_id:
- description: The ID of the Product Tag
- type: string
- example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- customer_group:
- description: Available if the relation `customer_group` is expanded.
- nullable: true
- $ref: ./CustomerGroup.yaml
- discount_condition:
- description: Available if the relation `discount_condition` is expanded.
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProduct.yaml
deleted file mode 100644
index 2fb9699b9e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProduct.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Product Discount Condition
-description: This represents the association between a discount condition and a product
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_id
- - updated_at
-properties:
- product_id:
- description: The ID of the Product Tag
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product:
- description: The details of the product.
- x-expandable: product
- nullable: true
- $ref: ./Product.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductCollection.yaml
deleted file mode 100644
index 5e8b88b9e3..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductCollection.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Collection Discount Condition
-description: >-
- This represents the association between a discount condition and a product
- collection
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_collection_id
- - updated_at
-properties:
- product_collection_id:
- description: The ID of the Product Collection
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_collection:
- description: The details of the product collection.
- x-expandable: product_collection
- nullable: true
- $ref: ./ProductCollection.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductTag.yaml
deleted file mode 100644
index 58ba07c6c3..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductTag.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Product Tag Discount Condition
-description: This represents the association between a discount condition and a product tag
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_tag_id
- - updated_at
-properties:
- product_tag_id:
- description: The ID of the Product Tag
- type: string
- example: ptag_01F0YESHPZYY3H4SJ3A5918SBN
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_tag:
- description: The details of the product tag.
- x-expandable: product_tag
- nullable: true
- $ref: ./ProductTag.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductType.yaml
deleted file mode 100644
index d93129494c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountConditionProductType.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Type Discount Condition
-description: >-
- This represents the association between a discount condition and a product
- type
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_type_id
- - updated_at
-properties:
- product_type_id:
- description: The ID of the Product Tag
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_type:
- description: The details of the product type.
- x-expandable: product_type
- nullable: true
- $ref: ./ProductType.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DiscountRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/DiscountRule.yaml
deleted file mode 100644
index caa7f9d604..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DiscountRule.yaml
+++ /dev/null
@@ -1,79 +0,0 @@
-title: Discount Rule
-description: A discount rule defines how a Discount is calculated when applied to a Cart.
-type: object
-required:
- - allocation
- - created_at
- - deleted_at
- - description
- - id
- - metadata
- - type
- - updated_at
- - value
-properties:
- id:
- description: The discount rule's ID
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- type:
- description: >-
- The type of the Discount, can be `fixed` for discounts that reduce the
- price by a fixed amount, `percentage` for percentage reductions or
- `free_shipping` for shipping vouchers.
- type: string
- enum:
- - fixed
- - percentage
- - free_shipping
- example: percentage
- description:
- description: A short description of the discount
- nullable: true
- type: string
- example: 10 Percent
- value:
- description: >-
- The value that the discount represents; this will depend on the type of
- the discount
- type: integer
- example: 10
- allocation:
- description: The scope that the discount should apply to.
- nullable: true
- type: string
- enum:
- - total
- - item
- example: total
- conditions:
- description: >-
- The details of the discount conditions associated with the rule. They can
- be used to limit when the discount can be used.
- type: array
- x-expandable: conditions
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/DraftOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/DraftOrder.yaml
deleted file mode 100644
index 86ff90bf25..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/DraftOrder.yaml
+++ /dev/null
@@ -1,103 +0,0 @@
-title: DraftOrder
-description: >-
- A draft order is created by an admin without direct involvement of the
- customer. Once its payment is marked as captured, it is transformed into an
- order.
-type: object
-required:
- - canceled_at
- - cart_id
- - completed_at
- - created_at
- - display_id
- - id
- - idempotency_key
- - metadata
- - no_notification_order
- - order_id
- - status
- - updated_at
-properties:
- id:
- description: The draft order's ID
- type: string
- example: dorder_01G8TJFKBG38YYFQ035MSVG03C
- status:
- description: >-
- The status of the draft order. It's changed to `completed` when it's
- transformed to an order.
- type: string
- enum:
- - open
- - completed
- default: open
- display_id:
- description: The draft order's display ID
- type: string
- example: 2
- cart_id:
- description: The ID of the cart associated with the draft order.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart associated with the draft order.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: >-
- The ID of the order created from the draft order when its payment is
- captured.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: >-
- The details of the order created from the draft order when its payment is
- captured.
- x-expandable: order
- nullable: true
- type: object
- canceled_at:
- description: The date the draft order was canceled at.
- nullable: true
- type: string
- format: date-time
- completed_at:
- description: The date the draft order was completed at.
- nullable: true
- type: string
- format: date-time
- no_notification_order:
- description: Whether to send the customer notifications regarding order updates.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the cart
- associated with the draft order in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ExtendedReservationItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/ExtendedReservationItem.yaml
deleted file mode 100644
index 7c4594004a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ExtendedReservationItem.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-allOf:
- - $ref: ./ReservationItemDTO.yaml
- - type: object
- properties:
- line_item:
- description: The line item associated with the reservation.
- $ref: ./LineItem.yaml
- inventory_item:
- description: The inventory item associated with the reservation.
- $ref: ./InventoryItemDTO.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml
deleted file mode 100644
index fe169bafc5..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ExtendedStoreDTO.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-allOf:
- - $ref: ./Store.yaml
- - type: object
- required:
- - payment_providers
- - fulfillment_providers
- - feature_flags
- - modules
- properties:
- payment_providers:
- description: The store's payment providers.
- $ref: ./PaymentProvider.yaml
- fulfillment_providers:
- description: The store's fulfillment providers.
- $ref: ./FulfillmentProvider.yaml
- feature_flags:
- description: The feature flags enabled in the store's backend.
- $ref: ./FeatureFlagsResponse.yaml
- modules:
- description: The modules installed in the store's backend.
- $ref: ./ModulesResponse.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/FeatureFlagsResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/FeatureFlagsResponse.yaml
deleted file mode 100644
index ce55d9ccc4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/FeatureFlagsResponse.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: array
-items:
- type: object
- required:
- - key
- - value
- properties:
- key:
- description: The key of the feature flag.
- type: string
- value:
- description: The value of the feature flag.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Fulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/Fulfillment.yaml
deleted file mode 100644
index b9f77587a4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Fulfillment.yaml
+++ /dev/null
@@ -1,151 +0,0 @@
-title: Fulfillment
-description: >-
- A Fulfillment is created once an admin can prepare the purchased goods.
- Fulfillments will eventually be shipped and hold information about how to
- track shipments. Fulfillments are created through a fulfillment provider,
- which typically integrates a third-party shipping service. Fulfillments can be
- associated with orders, claims, swaps, and returns.
-type: object
-required:
- - canceled_at
- - claim_order_id
- - created_at
- - data
- - id
- - idempotency_key
- - location_id
- - metadata
- - no_notification
- - order_id
- - provider_id
- - shipped_at
- - swap_id
- - tracking_numbers
- - updated_at
-properties:
- id:
- description: The fulfillment's ID
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- claim_order_id:
- description: The ID of the Claim that the Fulfillment belongs to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the fulfillment may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- swap_id:
- description: The ID of the Swap that the Fulfillment belongs to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the fulfillment may belong to.
- x-expandable: swap
- nullable: true
- type: object
- order_id:
- description: The ID of the Order that the Fulfillment belongs to.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the fulfillment may belong to.
- x-expandable: order
- nullable: true
- type: object
- provider_id:
- description: >-
- The ID of the Fulfillment Provider responsible for handling the
- fulfillment.
- type: string
- example: manual
- provider:
- description: >-
- The details of the fulfillment provider responsible for handling the
- fulfillment.
- x-expandable: provider
- nullable: true
- $ref: ./FulfillmentProvider.yaml
- location_id:
- description: The ID of the stock location the fulfillment will be shipped from
- nullable: true
- type: string
- example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
- items:
- description: >-
- The Fulfillment Items in the Fulfillment. These hold information about how
- many of each Line Item has been fulfilled.
- type: array
- x-expandable: items
- items:
- $ref: ./FulfillmentItem.yaml
- tracking_links:
- description: >-
- The Tracking Links that can be used to track the status of the
- Fulfillment. These will usually be provided by the Fulfillment Provider.
- type: array
- x-expandable: tracking_links
- items:
- $ref: ./TrackingLink.yaml
- tracking_numbers:
- description: >-
- The tracking numbers that can be used to track the status of the
- fulfillment.
- deprecated: true
- type: array
- items:
- type: string
- data:
- description: >-
- This contains all the data necessary for the Fulfillment provider to
- handle the fulfillment.
- type: object
- example: {}
- shipped_at:
- description: The date with timezone at which the Fulfillment was shipped.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: >-
- Flag for describing whether or not notifications related to this should be
- sent.
- nullable: true
- type: boolean
- example: false
- canceled_at:
- description: The date with timezone at which the Fulfillment was canceled.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the fulfillment
- in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/FulfillmentItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/FulfillmentItem.yaml
deleted file mode 100644
index 7204760274..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/FulfillmentItem.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
-title: Fulfillment Item
-description: This represents the association between a Line Item and a Fulfillment.
-type: object
-required:
- - fulfillment_id
- - item_id
- - quantity
-properties:
- fulfillment_id:
- description: The ID of the Fulfillment that the Fulfillment Item belongs to.
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- item_id:
- description: The ID of the Line Item that the Fulfillment Item references.
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- fulfillment:
- description: The details of the fulfillment.
- x-expandable: fulfillment
- nullable: true
- type: object
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- $ref: ./LineItem.yaml
- quantity:
- description: The quantity of the Line Item that is included in the Fulfillment.
- type: integer
- example: 1
diff --git a/www/apps/api-reference/specs/admin/components/schemas/FulfillmentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/FulfillmentProvider.yaml
deleted file mode 100644
index 366e045f2f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/FulfillmentProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Fulfillment Provider
-description: >-
- A fulfillment provider represents a fulfillment service installed in the
- Medusa backend, either through a plugin or backend customizations. It holds
- the fulfillment service's installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the fulfillment provider as given by the fulfillment service.
- type: string
- example: manual
- is_installed:
- description: >-
- Whether the fulfillment service is installed in the current version. If a
- fulfillment service is no longer installed, the `is_installed` attribute
- is set to `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/GiftCard.yaml b/www/apps/api-reference/specs/admin/components/schemas/GiftCard.yaml
deleted file mode 100644
index cd3b03dc19..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/GiftCard.yaml
+++ /dev/null
@@ -1,96 +0,0 @@
-title: Gift Card
-description: >-
- Gift Cards are redeemable and represent a value that can be used towards the
- payment of an Order.
-type: object
-required:
- - balance
- - code
- - created_at
- - deleted_at
- - ends_at
- - id
- - is_disabled
- - metadata
- - order_id
- - region_id
- - tax_rate
- - updated_at
- - value
-properties:
- id:
- description: The gift card's ID
- type: string
- example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
- code:
- description: >-
- The unique code that identifies the Gift Card. This is used by the
- Customer to redeem the value of the Gift Card.
- type: string
- example: 3RFT-MH2C-Y4YZ-XMN4
- value:
- description: The value that the Gift Card represents.
- type: integer
- example: 10
- balance:
- description: The remaining value on the Gift Card.
- type: integer
- example: 10
- region_id:
- description: The ID of the region this gift card is available in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this gift card is available in.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- order_id:
- description: The ID of the order that the gift card was purchased in.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the gift card was purchased in.
- x-expandable: region
- nullable: true
- type: object
- is_disabled:
- description: >-
- Whether the Gift Card has been disabled. Disabled Gift Cards cannot be
- applied to carts.
- type: boolean
- default: false
- ends_at:
- description: The time at which the Gift Card can no longer be used.
- nullable: true
- type: string
- format: date-time
- tax_rate:
- description: The gift card's tax rate that will be applied on calculating totals
- nullable: true
- type: number
- example: 0
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/GiftCardTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/GiftCardTransaction.yaml
deleted file mode 100644
index e1f3f9b490..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/GiftCardTransaction.yaml
+++ /dev/null
@@ -1,54 +0,0 @@
-title: Gift Card Transaction
-description: >-
- Gift Card Transactions are created once a Customer uses a Gift Card to pay for
- their Order.
-type: object
-required:
- - amount
- - created_at
- - gift_card_id
- - id
- - is_taxable
- - order_id
- - tax_rate
-properties:
- id:
- description: The gift card transaction's ID
- type: string
- example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A
- gift_card_id:
- description: The ID of the Gift Card that was used in the transaction.
- type: string
- example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
- gift_card:
- description: The details of the gift card associated used in this transaction.
- x-expandable: gift_card
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the gift card was used for payment.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the gift card was used for payment.
- x-expandable: order
- nullable: true
- type: object
- amount:
- description: The amount that was used from the Gift Card.
- type: integer
- example: 10
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- is_taxable:
- description: Whether the transaction is taxable or not.
- nullable: true
- type: boolean
- example: false
- tax_rate:
- description: The tax rate of the transaction
- nullable: true
- type: number
- example: 0
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/IdObject.yaml b/www/apps/api-reference/specs/admin/components/schemas/IdObject.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/IdObject.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/IdObject.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/IdempotencyKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/IdempotencyKey.yaml
deleted file mode 100644
index 9a8760eec9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/IdempotencyKey.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-title: Idempotency Key
-description: >-
- Idempotency Key is used to continue a process in case of any failure that
- might occur.
-type: object
-required:
- - created_at
- - id
- - idempotency_key
- - locked_at
- - recovery_point
- - response_code
- - response_body
- - request_method
- - request_params
- - request_path
-properties:
- id:
- description: The idempotency key's ID
- type: string
- example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
- idempotency_key:
- description: >-
- The unique randomly generated key used to determine the state of a
- process.
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: Date which the idempotency key was locked.
- type: string
- format: date-time
- locked_at:
- description: Date which the idempotency key was locked.
- nullable: true
- type: string
- format: date-time
- request_method:
- description: The method of the request
- nullable: true
- type: string
- example: POST
- request_params:
- description: The parameters passed to the request
- nullable: true
- type: object
- example:
- id: cart_01G8ZH853Y6TFXWPG5EYE81X63
- request_path:
- description: The request's path
- nullable: true
- type: string
- example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
- response_code:
- description: The response's code.
- nullable: true
- type: string
- example: 200
- response_body:
- description: The response's body
- nullable: true
- type: object
- example:
- id: cart_01G8ZH853Y6TFXWPG5EYE81X63
- recovery_point:
- description: Where to continue from.
- type: string
- default: started
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Image.yaml b/www/apps/api-reference/specs/admin/components/schemas/Image.yaml
deleted file mode 100644
index c837dd4b5d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Image.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Image
-description: >-
- An Image is used to store details about uploaded images. Images are uploaded
- by the File Service, and the URL is provided by the File Service.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - url
-properties:
- id:
- type: string
- description: The image's ID
- example: img_01G749BFYR6T8JTVW6SGW3K3E6
- url:
- description: The URL at which the image file can be found.
- type: string
- format: uri
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml
deleted file mode 100644
index 641ec3a26f..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/InventoryItemDTO.yaml
+++ /dev/null
@@ -1,82 +0,0 @@
-type: object
-required:
- - sku
-properties:
- id:
- description: The inventory item's ID.
- type: string
- example: iitem_12334
- sku:
- description: The Stock Keeping Unit (SKU) code of the Inventory Item.
- type: string
- hs_code:
- description: >-
- The Harmonized System code of the Inventory Item. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- origin_country:
- description: >-
- The country in which the Inventory Item was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Inventory Item. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
- type: string
- title:
- description: Title of the inventory item
- type: string
- description:
- description: Description of the inventory item
- type: string
- thumbnail:
- description: Thumbnail for the inventory item
- type: string
- material:
- description: >-
- The material and composition that the Inventory Item is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
- type: string
- weight:
- description: >-
- The weight of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- height:
- description: >-
- The height of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- width:
- description: >-
- The width of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- length:
- description: >-
- The length of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- requires_shipping:
- description: Whether the item requires shipping.
- type: boolean
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevelDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevelDTO.yaml
deleted file mode 100644
index 8540f71c95..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevelDTO.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-type: object
-required:
- - inventory_item_id
- - location_id
- - stocked_quantity
- - reserved_quantity
- - incoming_quantity
-properties:
- location_id:
- description: the item location ID
- type: string
- stocked_quantity:
- description: the total stock quantity of an inventory item at the given location ID
- type: number
- reserved_quantity:
- description: the reserved stock quantity of an inventory item at the given location ID
- type: number
- incoming_quantity:
- description: the incoming stock quantity of an inventory item at the given location ID
- type: number
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Invite.yaml b/www/apps/api-reference/specs/admin/components/schemas/Invite.yaml
deleted file mode 100644
index 4ab1e33195..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Invite.yaml
+++ /dev/null
@@ -1,68 +0,0 @@
-title: Invite
-description: >-
- An invite is created when an admin user invites a new user to join the store's
- team. Once the invite is accepted, it's deleted.
-type: object
-required:
- - accepted
- - created_at
- - deleted_at
- - expires_at
- - id
- - metadata
- - role
- - token
- - updated_at
- - user_email
-properties:
- id:
- type: string
- description: The invite's ID
- example: invite_01G8TKE4XYCTHSCK2GDEP47RE1
- user_email:
- description: The email of the user being invited.
- type: string
- format: email
- role:
- description: The user's role. These roles don't change the privileges of the user.
- nullable: true
- type: string
- enum:
- - admin
- - member
- - developer
- default: member
- accepted:
- description: Whether the invite was accepted or not.
- type: boolean
- default: false
- token:
- description: The token used to accept the invite.
- type: string
- expires_at:
- description: The date the invite expires at.
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/LineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/LineItem.yaml
deleted file mode 100644
index 155bafaedd..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/LineItem.yaml
+++ /dev/null
@@ -1,243 +0,0 @@
-title: Line Item
-description: >-
- Line Items are created when a product is added to a Cart. When Line Items are
- purchased they will get copied to the resulting order, swap, or claim, and can
- eventually be referenced in Fulfillments and Returns. Line items may also be
- used for order edits.
-type: object
-required:
- - allow_discounts
- - cart_id
- - claim_order_id
- - created_at
- - description
- - fulfilled_quantity
- - has_shipping
- - id
- - is_giftcard
- - is_return
- - metadata
- - order_edit_id
- - order_id
- - original_item_id
- - quantity
- - returned_quantity
- - shipped_quantity
- - should_merge
- - swap_id
- - thumbnail
- - title
- - unit_price
- - updated_at
- - variant_id
-properties:
- id:
- description: The line item's ID
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- cart_id:
- description: The ID of the cart that the line item may belongs to.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the line item may belongs to.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the line item may belongs to.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the line item may belongs to.
- x-expandable: order
- nullable: true
- type: object
- swap_id:
- description: The ID of the swap that the line item may belong to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the line item may belong to.
- x-expandable: swap
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the line item may belong to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the line item may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- tax_lines:
- description: The details of the item's tax lines.
- x-expandable: tax_lines
- type: array
- items:
- $ref: ./LineItemTaxLine.yaml
- adjustments:
- description: >-
- The details of the item's adjustments, which are available when a discount
- is applied on the item.
- x-expandable: adjustments
- type: array
- items:
- $ref: ./LineItemAdjustment.yaml
- original_item_id:
- description: >-
- The ID of the original line item. This is useful if the line item belongs
- to a resource that references an order, such as a return or an order edit.
- nullable: true
- type: string
- order_edit_id:
- description: The ID of the order edit that the item may belong to.
- nullable: true
- type: string
- order_edit:
- description: The details of the order edit.
- x-expandable: order_edit
- nullable: true
- type: object
- title:
- description: The title of the Line Item.
- type: string
- example: Medusa Coffee Mug
- description:
- description: A more detailed description of the contents of the Line Item.
- nullable: true
- type: string
- example: One Size
- thumbnail:
- description: A URL string to a small image of the contents of the Line Item.
- nullable: true
- type: string
- format: uri
- example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png
- is_return:
- description: Is the item being returned
- type: boolean
- default: false
- is_giftcard:
- description: Flag to indicate if the Line Item is a Gift Card.
- type: boolean
- default: false
- should_merge:
- description: >-
- Flag to indicate if new Line Items with the same variant should be merged
- or added as an additional Line Item.
- type: boolean
- default: true
- allow_discounts:
- description: >-
- Flag to indicate if the Line Item should be included when doing discount
- calculations.
- type: boolean
- default: true
- has_shipping:
- description: Flag to indicate if the Line Item has fulfillment associated with it.
- nullable: true
- type: boolean
- example: false
- unit_price:
- description: >-
- The price of one unit of the content in the Line Item. This should be in
- the currency defined by the Cart/Order/Swap/Claim that the Line Item
- belongs to.
- type: integer
- example: 8000
- variant_id:
- description: The id of the Product Variant contained in the Line Item.
- nullable: true
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that this item was created from.
- x-expandable: variant
- nullable: true
- $ref: ./ProductVariant.yaml
- quantity:
- description: The quantity of the content in the Line Item.
- type: integer
- example: 1
- fulfilled_quantity:
- description: The quantity of the Line Item that has been fulfilled.
- nullable: true
- type: integer
- example: 0
- returned_quantity:
- description: The quantity of the Line Item that has been returned.
- nullable: true
- type: integer
- example: 0
- shipped_quantity:
- description: The quantity of the Line Item that has been shipped.
- nullable: true
- type: integer
- example: 0
- refundable:
- description: >-
- The amount that can be refunded from the given Line Item. Takes taxes and
- discounts into consideration.
- type: integer
- example: 0
- subtotal:
- description: The subtotal of the line item
- type: integer
- example: 8000
- tax_total:
- description: The total of tax of the line item
- type: integer
- example: 0
- total:
- description: The total amount of the line item
- type: integer
- example: 8000
- original_total:
- description: The original total amount of the line item
- type: integer
- example: 8000
- original_tax_total:
- description: The original tax total amount of the line item
- type: integer
- example: 0
- discount_total:
- description: The total of discount of the line item rounded
- type: integer
- example: 0
- raw_discount_total:
- description: The total of discount of the line item
- type: integer
- example: 0
- gift_card_total:
- description: The total of the gift card of the line item
- type: integer
- example: 0
- includes_tax:
- description: Indicates if the line item unit_price include tax
- x-featureFlag: tax_inclusive_pricing
- type: boolean
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/LineItemAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/LineItemAdjustment.yaml
deleted file mode 100644
index 7d30b61c15..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/LineItemAdjustment.yaml
+++ /dev/null
@@ -1,52 +0,0 @@
-title: Line Item Adjustment
-description: A Line Item Adjustment includes details on discounts applied on a line item.
-type: object
-required:
- - amount
- - description
- - discount_id
- - id
- - item_id
- - metadata
-properties:
- id:
- description: The Line Item Adjustment's ID
- type: string
- example: lia_01G8TKE4XYCTHSCK2GDEP47RE1
- item_id:
- description: The ID of the line item
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- type: object
- description:
- description: The line item's adjustment description
- type: string
- example: Adjusted item's price.
- discount_id:
- description: The ID of the discount associated with the adjustment
- nullable: true
- type: string
- example: disc_01F0YESMW10MGHWJKZSDDMN0VN
- discount:
- description: The details of the discount associated with the adjustment.
- x-expandable: discount
- nullable: true
- $ref: ./Discount.yaml
- amount:
- description: The adjustment amount
- type: number
- example: 1000
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/LineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/LineItemTaxLine.yaml
deleted file mode 100644
index 69832cdd1e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/LineItemTaxLine.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-title: Line Item Tax Line
-description: A Line Item Tax Line represents the taxes applied on a line item.
-type: object
-required:
- - code
- - created_at
- - id
- - item_id
- - metadata
- - name
- - rate
- - updated_at
-properties:
- id:
- description: The line item tax line's ID
- type: string
- example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- item_id:
- description: The ID of the line item
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ModulesResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/ModulesResponse.yaml
deleted file mode 100644
index f90e78d9f9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ModulesResponse.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: array
-items:
- type: object
- required:
- - module
- - resolution
- properties:
- module:
- description: The key of the module.
- type: string
- resolution:
- description: The resolution path of the module or false if module is not installed.
- type: string
diff --git a/www/apps/api-reference/specs/admin/components/schemas/MoneyAmount.yaml b/www/apps/api-reference/specs/admin/components/schemas/MoneyAmount.yaml
deleted file mode 100644
index 920f9a3242..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/MoneyAmount.yaml
+++ /dev/null
@@ -1,101 +0,0 @@
-title: Money Amount
-description: >-
- A Money Amount represent a price amount, for example, a product variant's
- price or a price in a price list. Each Money Amount either has a Currency or
- Region associated with it to indicate the pricing in a given Currency or, for
- fully region-based pricing, the given price in a specific Region. If
- region-based pricing is used, the amount will be in the currency defined for
- the Region.
-type: object
-required:
- - amount
- - created_at
- - currency_code
- - deleted_at
- - id
- - max_quantity
- - min_quantity
- - price_list_id
- - region_id
- - updated_at
- - variant_id
-properties:
- id:
- description: The money amount's ID
- type: string
- example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
- currency_code:
- description: The 3 character currency code that the money amount may belong to.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency that the money amount may belong to.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- amount:
- description: >-
- The amount in the smallest currecny unit (e.g. cents 100 cents to charge
- $1) that the Product Variant will cost.
- type: integer
- example: 100
- min_quantity:
- description: >-
- The minimum quantity that the Money Amount applies to. If this value is
- not set, the Money Amount applies to all quantities.
- nullable: true
- type: integer
- example: 1
- max_quantity:
- description: >-
- The maximum quantity that the Money Amount applies to. If this value is
- not set, the Money Amount applies to all quantities.
- nullable: true
- type: integer
- example: 1
- price_list_id:
- description: The ID of the price list that the money amount may belong to.
- nullable: true
- type: string
- example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
- price_list:
- description: The details of the price list that the money amount may belong to.
- x-expandable: price_list
- nullable: true
- type: object
- variant_id:
- description: The ID of the Product Variant contained in the Line Item.
- nullable: true
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that the money amount may belong to.
- x-expandable: variant
- nullable: true
- type: object
- region_id:
- description: The region's ID
- nullable: true
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region that the money amount may belong to.
- x-expandable: region
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Note.yaml b/www/apps/api-reference/specs/admin/components/schemas/Note.yaml
deleted file mode 100644
index 9a33972604..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Note.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-title: Note
-description: >-
- A Note is an element that can be used in association with different resources
- to allow admin users to describe additional information. For example, they can
- be used to add additional information about orders.
-type: object
-required:
- - author_id
- - created_at
- - deleted_at
- - id
- - metadata
- - resource_id
- - resource_type
- - updated_at
- - value
-properties:
- id:
- description: The note's ID
- type: string
- example: note_01G8TM8ENBMC7R90XRR1G6H26Q
- resource_type:
- description: The type of resource that the Note refers to.
- type: string
- example: order
- resource_id:
- description: The ID of the resource that the Note refers to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- value:
- description: The contents of the note.
- type: string
- example: This order must be fulfilled on Monday
- author_id:
- description: The ID of the user that created the note.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- author:
- description: The details of the user that created the note.
- x-expandable: author
- nullable: true
- $ref: ./User.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Notification.yaml b/www/apps/api-reference/specs/admin/components/schemas/Notification.yaml
deleted file mode 100644
index 0d00e6fed4..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Notification.yaml
+++ /dev/null
@@ -1,93 +0,0 @@
-title: Notification
-description: >-
- A notification is an alert sent, typically to customers, using the installed
- Notification Provider as a reaction to internal events such as `order.placed`.
- Notifications can be resent.
-type: object
-required:
- - created_at
- - customer_id
- - data
- - event_name
- - id
- - parent_id
- - provider_id
- - resource_type
- - resource_id
- - to
- - updated_at
-properties:
- id:
- description: The notification's ID
- type: string
- example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
- event_name:
- description: The name of the event that the notification was sent for.
- nullable: true
- type: string
- example: order.placed
- resource_type:
- description: The type of resource that the Notification refers to.
- type: string
- example: order
- resource_id:
- description: The ID of the resource that the Notification refers to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- customer_id:
- description: The ID of the customer that this notification was sent to.
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer that this notification was sent to.
- x-expandable: customer
- nullable: true
- $ref: ./Customer.yaml
- to:
- description: >-
- The address that the Notification was sent to. This will usually be an
- email address, but can represent other addresses such as a chat bot user
- ID.
- type: string
- example: user@example.com
- data:
- description: >-
- The data that the Notification was sent with. This contains all the data
- necessary for the Notification Provider to initiate a resend.
- type: object
- example: {}
- parent_id:
- description: The notification's parent ID
- nullable: true
- type: string
- example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
- parent_notification:
- description: The details of the parent notification.
- x-expandable: parent_notification
- nullable: true
- type: object
- resends:
- description: The details of all resends of the notification.
- type: array
- x-expandable: resends
- items:
- type: object
- provider_id:
- description: The ID of the notification provider used to send the notification.
- nullable: true
- type: string
- example: sengrid
- provider:
- description: The notification provider used to send the notification.
- x-expandable: provider
- nullable: true
- $ref: ./NotificationProvider.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/NotificationProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/NotificationProvider.yaml
deleted file mode 100644
index d2d2e53288..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/NotificationProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Notification Provider
-description: >-
- A notification provider represents a notification service installed in the
- Medusa backend, either through a plugin or backend customizations. It holds
- the notification service's installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the notification provider as given by the notification service.
- type: string
- example: sendgrid
- is_installed:
- description: >-
- Whether the notification service is installed in the current version. If a
- notification service is no longer installed, the `is_installed` attribute
- is set to `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/OAuth.yaml b/www/apps/api-reference/specs/admin/components/schemas/OAuth.yaml
deleted file mode 100644
index b1ca6bf402..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/OAuth.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-title: OAuth
-description: >-
- An Oauth app is typically created by a plugin to handle authentication to
- third-party services.
-type: object
-required:
- - application_name
- - data
- - display_name
- - id
- - install_url
- - uninstall_url
-properties:
- id:
- description: The app's ID
- type: string
- example: example_app
- display_name:
- description: The app's display name
- type: string
- example: Example app
- application_name:
- description: The app's name
- type: string
- example: example
- install_url:
- description: The URL to install the app
- nullable: true
- type: string
- format: uri
- uninstall_url:
- description: The URL to uninstall the app
- nullable: true
- type: string
- format: uri
- data:
- description: Any data necessary to the app.
- nullable: true
- type: object
- example: {}
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml
deleted file mode 100644
index 9fb3daeff9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml
+++ /dev/null
@@ -1,349 +0,0 @@
-title: Order
-description: >-
- An order is a purchase made by a customer. It holds details about payment and
- fulfillment of the order. An order may also be created from a draft order,
- which is created by an admin user.
-type: object
-required:
- - billing_address_id
- - canceled_at
- - cart_id
- - created_at
- - currency_code
- - customer_id
- - draft_order_id
- - display_id
- - email
- - external_id
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - object
- - payment_status
- - region_id
- - shipping_address_id
- - status
- - tax_rate
- - updated_at
-properties:
- id:
- description: The order's ID
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- status:
- description: The order's status
- type: string
- enum:
- - pending
- - completed
- - archived
- - canceled
- - requires_action
- default: pending
- fulfillment_status:
- description: The order's fulfillment status
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- default: not_fulfilled
- payment_status:
- description: The order's payment status
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - partially_refunded
- - refunded
- - canceled
- - requires_action
- default: not_paid
- display_id:
- description: The order's display ID
- type: integer
- example: 2
- cart_id:
- description: The ID of the cart associated with the order
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart associated with the order.
- x-expandable: cart
- nullable: true
- type: object
- customer_id:
- description: The ID of the customer associated with the order
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer associated with the order.
- x-expandable: customer
- nullable: true
- type: object
- email:
- description: The email associated with the order
- type: string
- format: email
- billing_address_id:
- description: The ID of the billing address associated with the order
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the order.
- x-expandable: billing_address
- nullable: true
- $ref: ./Address.yaml
- shipping_address_id:
- description: The ID of the shipping address associated with the order
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address associated with the order.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- region_id:
- description: The ID of the region this order was created in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this order was created in.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- currency_code:
- description: The 3 character currency code that is used in the order
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency used in the order.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- tax_rate:
- description: The order's tax rate
- nullable: true
- type: number
- example: 0
- discounts:
- description: The details of the discounts applied on the order.
- type: array
- x-expandable: discounts
- items:
- $ref: ./Discount.yaml
- gift_cards:
- description: The details of the gift card used in the order.
- type: array
- x-expandable: gift_cards
- items:
- $ref: ./GiftCard.yaml
- shipping_methods:
- description: The details of the shipping methods used in the order.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- payments:
- description: The details of the payments used in the order.
- type: array
- x-expandable: payments
- items:
- type: object
- fulfillments:
- description: The details of the fulfillments created for the order.
- type: array
- x-expandable: fulfillments
- items:
- type: object
- returns:
- description: The details of the returns created for the order.
- type: array
- x-expandable: returns
- items:
- type: object
- claims:
- description: The details of the claims created for the order.
- type: array
- x-expandable: claims
- items:
- type: object
- refunds:
- description: The details of the refunds created for the order.
- type: array
- x-expandable: refunds
- items:
- type: object
- swaps:
- description: The details of the swaps created for the order.
- type: array
- x-expandable: swaps
- items:
- type: object
- draft_order_id:
- description: The ID of the draft order this order was created from.
- nullable: true
- type: string
- example: null
- draft_order:
- description: The details of the draft order this order was created from.
- x-expandable: draft_order
- nullable: true
- type: object
- items:
- description: The details of the line items that belong to the order.
- x-expandable: items
- type: array
- items:
- $ref: ./LineItem.yaml
- edits:
- description: The details of the order edits done on the order.
- type: array
- x-expandable: edits
- items:
- type: object
- gift_card_transactions:
- description: The gift card transactions made in the order.
- type: array
- x-expandable: gift_card_transactions
- items:
- $ref: ./GiftCardTransaction.yaml
- canceled_at:
- description: The date the order was canceled on.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: >-
- Flag for describing whether or not notifications related to this should be
- send.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the processing of the order in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- external_id:
- description: The ID of an external order.
- nullable: true
- type: string
- example: null
- sales_channel_id:
- description: The ID of the sales channel this order belongs to.
- nullable: true
- type: string
- example: null
- sales_channel:
- description: The details of the sales channel this order belongs to.
- x-expandable: sales_channel
- nullable: true
- $ref: ./SalesChannel.yaml
- shipping_total:
- type: integer
- description: The total of shipping
- example: 1000
- nullable: true
- shipping_tax_total:
- type: integer
- description: The tax total applied on shipping
- example: 1000
- raw_discount_total:
- description: The total of discount
- type: integer
- example: 800
- discount_total:
- description: The total of discount rounded
- type: integer
- example: 800
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- item_tax_total:
- description: The tax total applied on items
- type: integer
- example: 0
- nullable: true
- refunded_total:
- description: The total amount refunded if the order is returned.
- type: integer
- example: 0
- total:
- description: The total amount of the order
- type: integer
- example: 8200
- subtotal:
- description: The subtotal of the order
- type: integer
- example: 8000
- paid_total:
- description: The total amount paid
- type: integer
- example: 8000
- refundable_amount:
- description: The amount that can be refunded
- type: integer
- example: 8200
- gift_card_total:
- description: The total of gift cards
- type: integer
- example: 0
- gift_card_tax_total:
- description: The total of gift cards with taxes
- type: integer
- example: 0
- returnable_items:
- description: >-
- The details of the line items that are returnable as part of the order,
- swaps, or claims
- type: array
- x-expandable: returnable_items
- items:
- $ref: ./LineItem.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- sales_channels:
- description: The associated sales channels.
- type: array
- nullable: true
- x-expandable: sales_channels
- x-featureFlag: medusa_v2
- items:
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderEdit.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderEdit.yaml
deleted file mode 100644
index 27f1077bdb..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/OrderEdit.yaml
+++ /dev/null
@@ -1,170 +0,0 @@
-title: Order Edit
-description: >-
- Order edit allows modifying items in an order, such as adding, updating, or
- deleting items from the original order. Once the order edit is confirmed, the
- changes are reflected on the original order.
-type: object
-required:
- - canceled_at
- - canceled_by
- - confirmed_by
- - confirmed_at
- - created_at
- - created_by
- - declined_at
- - declined_by
- - declined_reason
- - id
- - internal_note
- - order_id
- - payment_collection_id
- - requested_at
- - requested_by
- - status
- - updated_at
-properties:
- id:
- description: The order edit's ID
- type: string
- example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
- order_id:
- description: The ID of the order that is edited
- type: string
- example: order_01G2SG30J8C85S4A5CHM2S1NS2
- order:
- description: The details of the order that this order edit was created for.
- x-expandable: order
- nullable: true
- type: object
- changes:
- description: The details of all the changes on the original order's line items.
- x-expandable: changes
- type: array
- items:
- $ref: ./OrderItemChange.yaml
- internal_note:
- description: An optional note with additional details about the order edit.
- nullable: true
- type: string
- example: Included two more items B to the order.
- created_by:
- description: The unique identifier of the user or customer who created the order edit.
- type: string
- requested_by:
- description: >-
- The unique identifier of the user or customer who requested the order
- edit.
- nullable: true
- type: string
- requested_at:
- description: The date with timezone at which the edit was requested.
- nullable: true
- type: string
- format: date-time
- confirmed_by:
- description: >-
- The unique identifier of the user or customer who confirmed the order
- edit.
- nullable: true
- type: string
- confirmed_at:
- description: The date with timezone at which the edit was confirmed.
- nullable: true
- type: string
- format: date-time
- declined_by:
- description: The unique identifier of the user or customer who declined the order edit.
- nullable: true
- type: string
- declined_at:
- description: The date with timezone at which the edit was declined.
- nullable: true
- type: string
- format: date-time
- declined_reason:
- description: An optional note why the order edit is declined.
- nullable: true
- type: string
- canceled_by:
- description: >-
- The unique identifier of the user or customer who cancelled the order
- edit.
- nullable: true
- type: string
- canceled_at:
- description: The date with timezone at which the edit was cancelled.
- nullable: true
- type: string
- format: date-time
- subtotal:
- description: The total of subtotal
- type: integer
- example: 8000
- discount_total:
- description: The total of discount
- type: integer
- example: 800
- shipping_total:
- description: The total of the shipping amount
- type: integer
- example: 800
- gift_card_total:
- description: The total of the gift card amount
- type: integer
- example: 800
- gift_card_tax_total:
- description: The total of the gift card tax amount
- type: integer
- example: 800
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- total:
- description: The total amount of the edited order.
- type: integer
- example: 8200
- difference_due:
- description: >-
- The difference between the total amount of the order and total amount of
- edited order.
- type: integer
- example: 8200
- status:
- description: The status of the order edit.
- type: string
- enum:
- - confirmed
- - declined
- - requested
- - created
- - canceled
- items:
- description: >-
- The details of the cloned items from the original order with the new
- changes. Once the order edit is confirmed, these line items are associated
- with the original order.
- type: array
- x-expandable: items
- items:
- $ref: ./LineItem.yaml
- payment_collection_id:
- description: The ID of the payment collection
- nullable: true
- type: string
- example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
- payment_collection:
- description: >-
- The details of the payment collection used to authorize additional payment
- if necessary.
- x-expandable: payment_collection
- nullable: true
- $ref: ./PaymentCollection.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderItemChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderItemChange.yaml
deleted file mode 100644
index a1cbe55425..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/OrderItemChange.yaml
+++ /dev/null
@@ -1,73 +0,0 @@
-title: Order Item Change
-description: >-
- An order item change is a change made within an order edit to an order's
- items. These changes are not reflected on the original order until the order
- edit is confirmed.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - line_item_id
- - order_edit_id
- - original_line_item_id
- - type
- - updated_at
-properties:
- id:
- description: The order item change's ID
- type: string
- example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
- type:
- description: The order item change's status
- type: string
- enum:
- - item_add
- - item_remove
- - item_update
- order_edit_id:
- description: The ID of the order edit
- type: string
- example: oe_01G2SG30J8C85S4A5CHM2S1NS2
- order_edit:
- description: The details of the order edit the item change is associated with.
- x-expandable: order_edit
- nullable: true
- type: object
- original_line_item_id:
- description: The ID of the original line item in the order
- nullable: true
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- original_line_item:
- description: >-
- The details of the original line item this item change references. This is
- used if the item change updates or deletes the original item.
- x-expandable: original_line_item
- nullable: true
- $ref: ./LineItem.yaml
- line_item_id:
- description: The ID of the cloned line item.
- nullable: true
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- line_item:
- description: >-
- The details of the resulting line item after the item change. This line
- item is then used in the original order once the order edit is confirmed.
- x-expandable: line_item
- nullable: true
- $ref: ./LineItem.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Payment.yaml b/www/apps/api-reference/specs/admin/components/schemas/Payment.yaml
deleted file mode 100644
index cf84c788ad..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Payment.yaml
+++ /dev/null
@@ -1,133 +0,0 @@
-title: Payment
-description: >-
- A payment is originally created from a payment session. Once a payment session
- is authorized, the payment is created to represent the authorized amount with
- a given payment method. Payments can be captured, canceled or refunded.
- Payments can be made towards orders, swaps, order edits, or other resources.
-type: object
-required:
- - amount
- - amount_refunded
- - canceled_at
- - captured_at
- - cart_id
- - created_at
- - currency_code
- - data
- - id
- - idempotency_key
- - metadata
- - order_id
- - provider_id
- - swap_id
- - updated_at
-properties:
- id:
- description: The payment's ID
- type: string
- example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
- swap_id:
- description: The ID of the swap that this payment was potentially created for.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that this payment was potentially created for.
- x-expandable: swap
- nullable: true
- type: object
- cart_id:
- description: The ID of the cart that the payment session was potentially created for.
- nullable: true
- type: string
- cart:
- description: >-
- The details of the cart that the payment session was potentially created
- for.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the payment session was potentially created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: >-
- The details of the order that the payment session was potentially created
- for.
- x-expandable: order
- nullable: true
- type: object
- amount:
- description: The amount that the Payment has been authorized for.
- type: integer
- example: 100
- currency_code:
- description: The 3 character ISO currency code of the payment.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency of the payment.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- amount_refunded:
- description: >-
- The amount of the original Payment amount that has been refunded back to
- the Customer.
- type: integer
- default: 0
- example: 0
- provider_id:
- description: The id of the Payment Provider that is responsible for the Payment
- type: string
- example: manual
- data:
- description: >-
- The data required for the Payment Provider to identify, modify and process
- the Payment. Typically this will be an object that holds an id to the
- external payment session, but can be an empty object if the Payment
- Provider doesn't hold any state.
- type: object
- example: {}
- captured_at:
- description: The date with timezone at which the Payment was captured.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date with timezone at which the Payment was canceled.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a payment in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml
deleted file mode 100644
index 4c8342dae9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PaymentCollection.yaml
+++ /dev/null
@@ -1,113 +0,0 @@
-title: Payment Collection
-description: >-
- A payment collection allows grouping and managing a list of payments at one.
- This can be helpful when making additional payment for order edits or
- integrating installment payments.
-type: object
-required:
- - amount
- - authorized_amount
- - created_at
- - created_by
- - currency_code
- - deleted_at
- - description
- - id
- - metadata
- - region_id
- - status
- - type
- - updated_at
-properties:
- id:
- description: The payment collection's ID
- type: string
- example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
- type:
- description: The type of the payment collection
- type: string
- enum:
- - order_edit
- status:
- description: The type of the payment collection
- type: string
- enum:
- - not_paid
- - awaiting
- - authorized
- - partially_authorized
- - canceled
- description:
- description: Description of the payment collection
- nullable: true
- type: string
- amount:
- description: Amount of the payment collection.
- type: integer
- authorized_amount:
- description: Authorized amount of the payment collection.
- nullable: true
- type: integer
- region_id:
- description: The ID of the region this payment collection is associated with.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this payment collection is associated with.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- currency_code:
- description: >-
- The three character ISO code for the currency this payment collection is
- associated with.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency this payment collection is associated with.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- payment_sessions:
- description: >-
- The details of the payment sessions created as part of the payment
- collection.
- type: array
- x-expandable: payment_sessions
- items:
- $ref: ./PaymentSession.yaml
- payments:
- description: The details of the payments created as part of the payment collection.
- type: array
- x-expandable: payments
- items:
- $ref: ./Payment.yaml
- created_by:
- description: The ID of the user that created the payment collection.
- type: string
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/PaymentProvider.yaml
deleted file mode 100644
index 4a54a90729..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PaymentProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Payment Provider
-description: >-
- A payment provider represents a payment service installed in the Medusa
- backend, either through a plugin or backend customizations. It holds the
- payment service's installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the payment provider as given by the payment service.
- type: string
- example: manual
- is_installed:
- description: >-
- Whether the payment service is installed in the current version. If a
- payment service is no longer installed, the `is_installed` attribute is
- set to `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PaymentSession.yaml b/www/apps/api-reference/specs/admin/components/schemas/PaymentSession.yaml
deleted file mode 100644
index ccf7cbcda8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PaymentSession.yaml
+++ /dev/null
@@ -1,105 +0,0 @@
-title: Payment Session
-description: >-
- A Payment Session is created when a Customer initilizes the checkout flow, and
- can be used to hold the state of a payment flow. Each Payment Session is
- controlled by a Payment Provider, which is responsible for the communication
- with external payment services. Authorized Payment Sessions will eventually
- get promoted to Payments to indicate that they are authorized for payment
- processing such as capture or refund. Payment sessions can also be used as
- part of payment collections.
-type: object
-required:
- - amount
- - cart_id
- - created_at
- - data
- - id
- - is_initiated
- - is_selected
- - idempotency_key
- - payment_authorized_at
- - provider_id
- - status
- - updated_at
-properties:
- id:
- description: The payment session's ID
- type: string
- example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
- cart_id:
- description: The ID of the cart that the payment session was created for.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the payment session was created for.
- x-expandable: cart
- nullable: true
- $ref: ./Cart.yaml
- provider_id:
- description: The ID of the Payment Provider that is responsible for the Payment Session
- type: string
- example: manual
- is_selected:
- description: >-
- A flag to indicate if the Payment Session has been selected as the method
- that will be used to complete the purchase.
- nullable: true
- type: boolean
- example: true
- is_initiated:
- description: >-
- A flag to indicate if a communication with the third party provider has
- been initiated.
- type: boolean
- default: false
- example: true
- status:
- description: >-
- Indicates the status of the Payment Session. Will default to `pending`,
- and will eventually become `authorized`. Payment Sessions may have the
- status of `requires_more` to indicate that further actions are to be
- completed by the Customer.
- type: string
- enum:
- - authorized
- - pending
- - requires_more
- - error
- - canceled
- example: pending
- data:
- description: >-
- The data required for the Payment Provider to identify, modify and process
- the Payment Session. Typically this will be an object that holds an id to
- the external payment session, but can be an empty object if the Payment
- Provider doesn't hold any state.
- type: object
- example: {}
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a cart in case
- of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- amount:
- description: The amount that the Payment Session has been authorized for.
- nullable: true
- type: integer
- example: 100
- payment_authorized_at:
- description: The date with timezone at which the Payment Session was authorized.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/PriceList.yaml
deleted file mode 100644
index cb1f79566a..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PriceList.yaml
+++ /dev/null
@@ -1,83 +0,0 @@
-title: Price List
-description: >-
- A Price List represents a set of prices that override the default price for
- one or more product variants.
-type: object
-required:
- - created_at
- - deleted_at
- - description
- - ends_at
- - id
- - name
- - starts_at
- - status
- - type
- - updated_at
-properties:
- id:
- description: The price list's ID
- type: string
- example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
- name:
- description: The price list's name
- type: string
- example: VIP Prices
- description:
- description: The price list's description
- type: string
- example: Prices for VIP customers
- type:
- description: The type of Price List. This can be one of either `sale` or `override`.
- type: string
- enum:
- - sale
- - override
- default: sale
- status:
- description: The status of the Price List
- type: string
- enum:
- - active
- - draft
- default: draft
- starts_at:
- description: The date with timezone that the Price List starts being valid.
- nullable: true
- type: string
- format: date-time
- ends_at:
- description: The date with timezone that the Price List stops being valid.
- nullable: true
- type: string
- format: date-time
- customer_groups:
- description: The details of the customer groups that the Price List can apply to.
- type: array
- x-expandable: customer_groups
- items:
- $ref: ./CustomerGroup.yaml
- prices:
- description: The prices that belong to the price list, represented as a Money Amount.
- type: array
- x-expandable: prices
- items:
- $ref: ./MoneyAmount.yaml
- includes_tax:
- description: Whether the price list prices include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml
deleted file mode 100644
index aa57632b38..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PricedProduct.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-title: Priced Product
-type: object
-allOf:
- - $ref: ./Product.yaml
- - type: object
- properties:
- variants:
- description: The product variants and their prices.
- type: array
- items:
- $ref: ./PricedVariant.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PricedShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/PricedShippingOption.yaml
deleted file mode 100644
index a5f479328b..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PricedShippingOption.yaml
+++ /dev/null
@@ -1,27 +0,0 @@
-title: Priced Shipping Option
-type: object
-allOf:
- - $ref: ./ShippingOption.yaml
- - type: object
- properties:
- price_incl_tax:
- type: number
- description: Price including taxes
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
- tax_amount:
- type: number
- description: The taxes applied.
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PricedVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/PricedVariant.yaml
deleted file mode 100644
index 4b74691549..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PricedVariant.yaml
+++ /dev/null
@@ -1,41 +0,0 @@
-title: Priced Product Variant
-type: object
-allOf:
- - $ref: ./ProductVariant.yaml
- - type: object
- properties:
- original_price:
- type: number
- description: >-
- The original price of the variant without any discounted prices
- applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Product.yaml b/www/apps/api-reference/specs/admin/components/schemas/Product.yaml
deleted file mode 100644
index d0f98a63f1..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Product.yaml
+++ /dev/null
@@ -1,253 +0,0 @@
-title: Product
-description: >-
- A product is a saleable item that holds general information such as name or
- description. It must include at least one Product Variant, where each product
- variant defines different options to purchase the product with (for example,
- different sizes or colors). The prices and inventory of the product are
- defined on the variant level.
-type: object
-required:
- - collection_id
- - created_at
- - deleted_at
- - description
- - discountable
- - external_id
- - handle
- - height
- - hs_code
- - id
- - is_giftcard
- - length
- - material
- - metadata
- - mid_code
- - origin_country
- - profile_id
- - status
- - subtitle
- - type_id
- - thumbnail
- - title
- - updated_at
- - weight
- - width
-properties:
- id:
- description: The product's ID
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- title:
- description: A title that can be displayed for easy identification of the Product.
- type: string
- example: Medusa Coffee Mug
- subtitle:
- description: An optional subtitle that can be used to further specify the Product.
- nullable: true
- type: string
- description:
- description: A short description of the Product.
- nullable: true
- type: string
- example: Every programmer's best friend.
- handle:
- description: A unique identifier for the Product (e.g. for slug structure).
- nullable: true
- type: string
- example: coffee-mug
- is_giftcard:
- description: >-
- Whether the Product represents a Gift Card. Products that represent Gift
- Cards will automatically generate a redeemable Gift Card code once they
- are purchased.
- type: boolean
- default: false
- status:
- description: The status of the product
- type: string
- enum:
- - draft
- - proposed
- - published
- - rejected
- default: draft
- images:
- description: The details of the product's images.
- type: array
- x-expandable: images
- items:
- $ref: ./Image.yaml
- thumbnail:
- description: A URL to an image file that can be used to identify the Product.
- nullable: true
- type: string
- format: uri
- options:
- description: >-
- The details of the Product Options that are defined for the Product. The
- product's variants will have a unique combination of values of the
- product's options.
- type: array
- x-expandable: options
- items:
- $ref: ./ProductOption.yaml
- variants:
- description: >-
- The details of the Product Variants that belong to the Product. Each will
- have a unique combination of values of the product's options.
- type: array
- x-expandable: variants
- items:
- $ref: ./ProductVariant.yaml
- categories:
- description: The details of the product categories that this product belongs to.
- type: array
- x-expandable: categories
- x-featureFlag: product_categories
- items:
- $ref: ./ProductCategory.yaml
- profile_id:
- description: >-
- The ID of the shipping profile that the product belongs to. The shipping
- profile has a set of defined shipping options that can be used to fulfill
- the product.
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- profile:
- description: >-
- The details of the shipping profile that the product belongs to. The
- shipping profile has a set of defined shipping options that can be used to
- fulfill the product.
- x-expandable: profile
- nullable: true
- $ref: ./ShippingProfile.yaml
- profiles:
- description: Available if the relation `profiles` is expanded.
- nullable: true
- type: array
- items:
- $ref: ./ShippingProfile.yaml
- weight:
- description: >-
- The weight of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- length:
- description: >-
- The length of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- height:
- description: >-
- The height of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- width:
- description: >-
- The width of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- hs_code:
- description: >-
- The Harmonized System code of the Product Variant. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- origin_country:
- description: >-
- The country in which the Product Variant was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Product Variant. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
- nullable: true
- type: string
- example: null
- material:
- description: >-
- The material and composition that the Product Variant is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
- nullable: true
- type: string
- example: null
- collection_id:
- description: The ID of the product collection that the product belongs to.
- nullable: true
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- collection:
- description: The details of the product collection that the product belongs to.
- x-expandable: collection
- nullable: true
- $ref: ./ProductCollection.yaml
- type_id:
- description: The ID of the product type that the product belongs to.
- nullable: true
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- type:
- description: The details of the product type that the product belongs to.
- x-expandable: type
- nullable: true
- $ref: ./ProductType.yaml
- tags:
- description: The details of the product tags used in this product.
- type: array
- x-expandable: type
- items:
- $ref: ./ProductTag.yaml
- discountable:
- description: >-
- Whether the Product can be discounted. Discounts will not apply to Line
- Items of this Product when this flag is set to `false`.
- type: boolean
- default: true
- external_id:
- description: The external ID of the product
- nullable: true
- type: string
- example: null
- sales_channels:
- description: The details of the sales channels this product is available in.
- type: array
- x-expandable: sales_channels
- items:
- $ref: ./SalesChannel.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml
deleted file mode 100644
index 2a9d4d63a0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductCategory.yaml
+++ /dev/null
@@ -1,97 +0,0 @@
-title: Product Category
-description: >-
- A product category can be used to categorize products into a hierarchy of
- categories.
-x-resourceId: ProductCategory
-x-featureFlag: product_categories
-type: object
-required:
- - category_children
- - created_at
- - handle
- - id
- - is_active
- - is_internal
- - metadata
- - mpath
- - name
- - parent_category_id
- - updated_at
-properties:
- id:
- description: The product category's ID
- type: string
- example: pcat_01G2SG30J8C85S4A5CHM2S1NS2
- name:
- description: The product category's name
- type: string
- example: Regular Fit
- description:
- description: The product category's description.
- type: string
- default: ''
- handle:
- description: >-
- A unique string that identifies the Product Category - can for example be
- used in slug structures.
- type: string
- example: regular-fit
- mpath:
- description: >-
- A string for Materialized Paths - used for finding ancestors and
- descendents
- nullable: true
- type: string
- example: pcat_id1.pcat_id2.pcat_id3
- is_internal:
- type: boolean
- description: A flag to make product category an internal category for admins
- default: false
- is_active:
- type: boolean
- description: A flag to make product category visible/hidden in the store front
- default: false
- rank:
- type: integer
- description: An integer that depicts the rank of category in a tree node
- default: 0
- category_children:
- description: The details of the category's children.
- type: array
- x-expandable: category_children
- items:
- type: object
- parent_category_id:
- description: The ID of the parent category.
- nullable: true
- type: string
- default: null
- parent_category:
- description: The details of the parent of this category.
- x-expandable: parent_category
- nullable: true
- type: object
- products:
- description: The details of the products that belong to this category.
- type: array
- x-expandable: products
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductCollection.yaml
deleted file mode 100644
index 82b6fbcca8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductCollection.yaml
+++ /dev/null
@@ -1,59 +0,0 @@
-title: Product Collection
-description: >-
- A Product Collection allows grouping together products for promotional
- purposes. For example, an admin can create a Summer collection, add products
- to it, and showcase it on the storefront.
-type: object
-required:
- - created_at
- - deleted_at
- - handle
- - id
- - metadata
- - title
- - updated_at
-properties:
- id:
- description: The product collection's ID
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- title:
- description: The title that the Product Collection is identified by.
- type: string
- example: Summer Collection
- handle:
- description: >-
- A unique string that identifies the Product Collection - can for example
- be used in slug structures.
- nullable: true
- type: string
- example: summer-collection
- products:
- description: The details of the products that belong to this product collection.
- type: array
- x-expandable: products
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductOption.yaml
deleted file mode 100644
index 6e2d829a9e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductOption.yaml
+++ /dev/null
@@ -1,61 +0,0 @@
-title: Product Option
-description: >-
- A Product Option defines properties that may vary between different variants
- of a Product. Common Product Options are "Size" and "Color". Admins are free
- to create any product options.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - product_id
- - title
- - updated_at
-properties:
- id:
- description: The product option's ID
- type: string
- example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
- title:
- description: The title that the Product Option is defined by (e.g. `Size`).
- type: string
- example: Size
- values:
- description: The details of the values of the product option.
- type: array
- x-expandable: values
- items:
- $ref: ./ProductOptionValue.yaml
- product_id:
- description: The ID of the product that this product option belongs to.
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product that this product option belongs to.
- x-expandable: product
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductOptionValue.yaml
deleted file mode 100644
index af9257805c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductOptionValue.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-title: Product Option Value
-description: >-
- An option value is one of the possible values of a Product Option. Product
- Variants specify a unique combination of product option values.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - option_id
- - updated_at
- - value
- - variant_id
-properties:
- id:
- description: The product option value's ID
- type: string
- example: optval_01F0YESHR7S6ECD03RF6W12DSJ
- value:
- description: >-
- The value that the Product Variant has defined for the specific Product
- Option (e.g. if the Product Option is "Size" this value could be `Small`,
- `Medium` or `Large`).
- type: string
- example: large
- option_id:
- description: The ID of the Product Option that the Product Option Value belongs to.
- type: string
- example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
- option:
- description: >-
- The details of the product option that the Product Option Value belongs
- to.
- x-expandable: option
- nullable: true
- type: object
- variant_id:
- description: The ID of the product variant that uses this product option value.
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that uses this product option value.
- x-expandable: variant
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductTag.yaml
deleted file mode 100644
index 829162f285..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductTag.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-title: Product Tag
-description: A Product Tag can be added to Products for easy filtering and grouping.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
-properties:
- id:
- description: The product tag's ID
- type: string
- example: ptag_01G8K2MTMG9168F2B70S1TAVK3
- value:
- description: The value that the Product Tag represents
- type: string
- example: Pants
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductTaxRate.yaml
deleted file mode 100644
index 55292d8e33..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductTaxRate.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Tax Rate
-description: >-
- This represents the association between a tax rate and a product to indicate
- that the product is taxed in a way different than the default.
-type: object
-required:
- - created_at
- - metadata
- - product_id
- - rate_id
- - updated_at
-properties:
- product_id:
- description: The ID of the Product
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product.
- x-expandable: product
- nullable: true
- $ref: ./Product.yaml
- rate_id:
- description: The ID of the Tax Rate
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: ./TaxRate.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductType.yaml
deleted file mode 100644
index dbdc684090..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductType.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-title: Product Type
-description: A Product Type can be added to Products for filtering and reporting purposes.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
-properties:
- id:
- description: The product type's ID
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- value:
- description: The value that the Product Type represents.
- type: string
- example: Clothing
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductTypeTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductTypeTaxRate.yaml
deleted file mode 100644
index 3c641ab1fe..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductTypeTaxRate.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Type Tax Rate
-description: >-
- This represents the association between a tax rate and a product type to
- indicate that the product type is taxed in a different way than the default.
-type: object
-required:
- - created_at
- - metadata
- - product_type_id
- - rate_id
- - updated_at
-properties:
- product_type_id:
- description: The ID of the Product type
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_type:
- description: The details of the product type.
- x-expandable: product_type
- nullable: true
- $ref: ./ProductType.yaml
- rate_id:
- description: The id of the Tax Rate
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: ./TaxRate.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductVariant.yaml
deleted file mode 100644
index ad7ee83ce8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductVariant.yaml
+++ /dev/null
@@ -1,208 +0,0 @@
-title: Product Variant
-description: >-
- A Product Variant represents a Product with a specific set of Product Option
- configurations. The maximum number of Product Variants that a Product can have
- is given by the number of available Product Option combinations. A product
- must at least have one product variant.
-type: object
-required:
- - allow_backorder
- - barcode
- - created_at
- - deleted_at
- - ean
- - height
- - hs_code
- - id
- - inventory_quantity
- - length
- - manage_inventory
- - material
- - metadata
- - mid_code
- - origin_country
- - product_id
- - sku
- - title
- - upc
- - updated_at
- - weight
- - width
-properties:
- id:
- description: The product variant's ID
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- title:
- description: >-
- A title that can be displayed for easy identification of the Product
- Variant.
- type: string
- example: Small
- product_id:
- description: The ID of the product that the product variant belongs to.
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product that the product variant belongs to.
- x-expandable: product
- nullable: true
- type: object
- prices:
- description: >-
- The details of the prices of the Product Variant, each represented as a
- Money Amount. Each Money Amount represents a price in a given currency or
- a specific Region.
- type: array
- x-expandable: prices
- items:
- $ref: ./MoneyAmount.yaml
- sku:
- description: >-
- The unique stock keeping unit used to identify the Product Variant. This
- will usually be a unique identifer for the item that is to be shipped, and
- can be referenced across multiple systems.
- nullable: true
- type: string
- example: shirt-123
- barcode:
- description: >-
- A generic field for a GTIN number that can be used to identify the Product
- Variant.
- nullable: true
- type: string
- example: null
- ean:
- description: An EAN barcode number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- upc:
- description: A UPC barcode number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- variant_rank:
- description: The ranking of this variant
- nullable: true
- type: number
- default: 0
- inventory_quantity:
- description: The current quantity of the item that is stocked.
- type: integer
- example: 100
- allow_backorder:
- description: >-
- Whether the Product Variant should be purchasable when
- `inventory_quantity` is 0.
- type: boolean
- default: false
- manage_inventory:
- description: Whether Medusa should manage inventory for the Product Variant.
- type: boolean
- default: true
- hs_code:
- description: >-
- The Harmonized System code of the Product Variant. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- origin_country:
- description: >-
- The country in which the Product Variant was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Product Variant. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
- nullable: true
- type: string
- example: null
- material:
- description: >-
- The material and composition that the Product Variant is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
- nullable: true
- type: string
- example: null
- weight:
- description: >-
- The weight of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- length:
- description: >-
- The length of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- height:
- description: >-
- The height of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- width:
- description: >-
- The width of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- options:
- description: >-
- The details of the product options that this product variant defines
- values for.
- type: array
- x-expandable: options
- items:
- $ref: ./ProductOptionValue.yaml
- inventory_items:
- description: The details inventory items of the product variant.
- type: array
- x-expandable: inventory_items
- items:
- $ref: ./ProductVariantInventoryItem.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- purchasable:
- description: |
- Only used with the inventory modules.
- A boolean value indicating whether the Product Variant is purchasable.
- A variant is purchasable if:
- - inventory is not managed
- - it has no inventory items
- - it is in stock
- - it is backorderable.
- type: boolean
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ProductVariantInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/ProductVariantInventoryItem.yaml
deleted file mode 100644
index 2da5bc3821..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ProductVariantInventoryItem.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Product Variant Inventory Item
-description: >-
- A Product Variant Inventory Item links variants with inventory items and
- denotes the required quantity of the variant.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - inventory_item_id
- - required_quantity
- - updated_at
- - variant_id
-properties:
- id:
- description: The product variant inventory item's ID
- type: string
- example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
- inventory_item_id:
- description: The id of the inventory item
- type: string
- variant_id:
- description: The id of the variant.
- type: string
- variant:
- description: The details of the product variant.
- x-expandable: variant
- nullable: true
- type: object
- required_quantity:
- description: The quantity of an inventory item required for the variant.
- type: integer
- default: 1
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/Promotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/Promotion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/Promotion.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/Promotion.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/PromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/PromotionRule.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/PromotionRule.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/PromotionRule.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PublishableApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/PublishableApiKey.yaml
deleted file mode 100644
index d94df58632..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PublishableApiKey.yaml
+++ /dev/null
@@ -1,49 +0,0 @@
-title: Publishable API key
-description: >-
- A Publishable API key defines scopes that resources are available in. Then, it
- can be used in request to infer the resources without having to directly pass
- them. For example, a publishable API key can be associated with one or more
- sales channels. Then, when the publishable API key is passed in the header of
- a request, it is inferred what sales channel is being used without having to
- pass the sales channel as a query or body parameter of the request.
- Publishable API keys can only be used with sales channels, at the moment.
-type: object
-required:
- - created_at
- - created_by
- - id
- - revoked_by
- - revoked_at
- - title
- - updated_at
-properties:
- id:
- description: The key's ID
- type: string
- example: pk_01G1G5V27GYX4QXNARRQCW1N8T
- created_by:
- description: The unique identifier of the user that created the key.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- revoked_by:
- description: The unique identifier of the user that revoked the key.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- revoked_at:
- description: The date with timezone at which the key was revoked.
- nullable: true
- type: string
- format: date-time
- title:
- description: The key's title.
- type: string
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/PublishableApiKeySalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/PublishableApiKeySalesChannel.yaml
deleted file mode 100644
index fc7419a6d8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/PublishableApiKeySalesChannel.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-title: Publishable API Key Sales Channel
-description: >-
- This represents the association between the Publishable API keys and Sales
- Channels
-type: object
-required:
- - publishable_key_id
- - sales_channel_id
- - created_at
- - updated_at
- - deleted_at
-properties:
- id:
- description: The relation's ID
- type: string
- example: pksc_01G8X9A7ESKAJXG2H0E6F1MW7A
- sales_channel_id:
- description: The sales channel's ID
- type: string
- example: sc_01G1G5V21KADXNGH29BJMAJ4B4
- publishable_key_id:
- description: The publishable API key's ID
- type: string
- example: pak_01G1G5V21KADXNGH29BJMAJ4B4
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Refund.yaml b/www/apps/api-reference/specs/admin/components/schemas/Refund.yaml
deleted file mode 100644
index 0438bfe295..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Refund.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-title: Refund
-description: >-
- A refund represents an amount of money transfered back to the customer for a
- given reason. Refunds may occur in relation to Returns, Swaps and Claims, but
- can also be initiated by an admin for an order.
-type: object
-required:
- - amount
- - created_at
- - id
- - idempotency_key
- - metadata
- - note
- - order_id
- - payment_id
- - reason
- - updated_at
-properties:
- id:
- description: The refund's ID
- type: string
- example: ref_01G1G5V27GYX4QXNARRQCW1N8T
- order_id:
- description: The ID of the order this refund was created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order this refund was created for.
- x-expandable: order
- nullable: true
- type: object
- payment_id:
- description: The payment's ID, if available.
- nullable: true
- type: string
- example: pay_01G8ZCC5W42ZNY842124G7P5R9
- payment:
- description: The details of the payment associated with the refund.
- x-expandable: payment
- nullable: true
- type: object
- amount:
- description: The amount that has be refunded to the Customer.
- type: integer
- example: 1000
- note:
- description: An optional note explaining why the amount was refunded.
- nullable: true
- type: string
- example: I didn't like it
- reason:
- description: >-
- The reason given for the Refund, will automatically be set when processed
- as part of a Swap, Claim or Return.
- type: string
- enum:
- - discount
- - return
- - swap
- - claim
- - other
- example: return
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the refund in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Region.yaml b/www/apps/api-reference/specs/admin/components/schemas/Region.yaml
deleted file mode 100644
index b9f3b0c9e3..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Region.yaml
+++ /dev/null
@@ -1,130 +0,0 @@
-title: Region
-description: >-
- A region holds settings specific to a geographical location, including the
- currency, tax rates, and fulfillment and payment providers. A Region can
- consist of multiple countries to accomodate common shopping settings across
- countries.
-type: object
-required:
- - automatic_taxes
- - created_at
- - currency_code
- - deleted_at
- - gift_cards_taxable
- - id
- - metadata
- - name
- - tax_code
- - tax_provider_id
- - tax_rate
- - updated_at
-properties:
- id:
- description: The region's ID
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- name:
- description: >-
- The name of the region as displayed to the customer. If the Region only
- has one country it is recommended to write the country name.
- type: string
- example: EU
- currency_code:
- description: The three character currency code used in the region.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency used in the region.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- tax_rate:
- description: The tax rate that should be charged on purchases in the Region.
- type: number
- example: 0
- tax_rates:
- description: >-
- The details of the tax rates used in the region, aside from the default
- rate.
- type: array
- x-expandable: tax_rates
- items:
- $ref: ./TaxRate.yaml
- tax_code:
- description: >-
- The tax code used on purchases in the Region. This may be used by other
- systems for accounting purposes.
- nullable: true
- type: string
- example: null
- gift_cards_taxable:
- description: Whether the gift cards are taxable or not in this region.
- type: boolean
- default: true
- automatic_taxes:
- description: Whether taxes should be automated in this region.
- type: boolean
- default: true
- countries:
- description: The details of the countries included in this region.
- type: array
- x-expandable: countries
- items:
- $ref: ./Country.yaml
- tax_provider_id:
- description: The ID of the tax provider used in this region
- nullable: true
- type: string
- example: null
- tax_provider:
- description: The details of the tax provider used in the region.
- x-expandable: tax_provider
- nullable: true
- $ref: ./TaxProvider.yaml
- payment_providers:
- description: >-
- The details of the payment providers that can be used to process payments
- in the region.
- type: array
- x-expandable: payment_providers
- items:
- $ref: ./PaymentProvider.yaml
- fulfillment_providers:
- description: >-
- The details of the fulfillment providers that can be used to fulfill items
- of orders and similar resources in the region.
- type: array
- x-expandable: fulfillment_providers
- items:
- $ref: ./FulfillmentProvider.yaml
- includes_tax:
- description: Whether the prices for the region include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ReservationItemDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/ReservationItemDTO.yaml
deleted file mode 100644
index 5e4f31bfec..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ReservationItemDTO.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Reservation item
-description: Represents a reservation of an inventory item at a stock location
-type: object
-required:
- - id
- - location_id
- - inventory_item_id
- - quantity
-properties:
- id:
- description: The id of the reservation item
- type: string
- location_id:
- description: The id of the location of the reservation
- type: string
- inventory_item_id:
- description: The id of the inventory item the reservation relates to
- type: string
- description:
- description: Description of the reservation item
- type: string
- created_by:
- description: UserId of user who created the reservation item
- type: string
- quantity:
- description: The id of the reservation item
- type: number
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ResponseInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/ResponseInventoryItem.yaml
deleted file mode 100644
index 6a141e4ba9..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ResponseInventoryItem.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-allOf:
- - $ref: ./InventoryItemDTO.yaml
- - type: object
- properties:
- location_levels:
- type: array
- description: The inventory's location levels.
- items:
- allOf:
- - $ref: ./InventoryItemDTO.yaml
- - type: object
- required:
- - available_quantity
- properties:
- available_quantity:
- description: The available quantity in the inventory location.
- type: number
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml
deleted file mode 100644
index d7145a0dff..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml
+++ /dev/null
@@ -1,132 +0,0 @@
-title: Return
-description: >-
- A Return holds information about Line Items that a Customer wishes to send
- back, along with how the items will be returned. Returns can also be used as
- part of a Swap or a Claim.
-type: object
-required:
- - claim_order_id
- - created_at
- - id
- - idempotency_key
- - location_id
- - metadata
- - no_notification
- - order_id
- - received_at
- - refund_amount
- - shipping_data
- - status
- - swap_id
- - updated_at
-properties:
- id:
- description: The return's ID
- type: string
- example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
- status:
- description: Status of the Return.
- type: string
- enum:
- - requested
- - received
- - requires_action
- - canceled
- default: requested
- items:
- description: The details of the items that the customer is returning.
- type: array
- x-expandable: items
- items:
- $ref: ./ReturnItem.yaml
- swap_id:
- description: The ID of the swap that the return may belong to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the return may belong to.
- x-expandable: swap
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the return may belong to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the return may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the return was created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the return was created for.
- x-expandable: order
- nullable: true
- type: object
- shipping_method:
- description: >-
- The details of the Shipping Method that will be used to send the Return
- back. Can be null if the Customer will handle the return shipment
- themselves.
- x-expandable: shipping_method
- nullable: true
- $ref: ./ShippingMethod.yaml
- shipping_data:
- description: >-
- Data about the return shipment as provided by the Fulfilment Provider that
- handles the return shipment.
- nullable: true
- type: object
- example: {}
- location_id:
- description: The ID of the stock location the return will be added back.
- nullable: true
- type: string
- example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
- refund_amount:
- description: The amount that should be refunded as a result of the return.
- type: integer
- example: 1000
- no_notification:
- description: When set to true, no notification will be sent related to this return.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the return in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- received_at:
- description: The date with timezone at which the return was received.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/ReturnItem.yaml
deleted file mode 100644
index cbdf122007..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ReturnItem.yaml
+++ /dev/null
@@ -1,79 +0,0 @@
-title: Return Item
-description: >-
- A return item represents a line item in an order that is to be returned. It
- includes details related to the return and the reason behind it.
-type: object
-required:
- - is_requested
- - item_id
- - metadata
- - note
- - quantity
- - reason_id
- - received_quantity
- - requested_quantity
- - return_id
-properties:
- return_id:
- description: The ID of the Return that the Return Item belongs to.
- type: string
- example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
- item_id:
- description: The ID of the Line Item that the Return Item references.
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- return_order:
- description: Details of the Return that the Return Item belongs to.
- x-expandable: return_order
- nullable: true
- type: object
- item:
- description: The details of the line item in the original order to be returned.
- x-expandable: item
- nullable: true
- $ref: ./LineItem.yaml
- quantity:
- description: The quantity of the Line Item to be returned.
- type: integer
- example: 1
- is_requested:
- description: >-
- Whether the Return Item was requested initially or received unexpectedly
- in the warehouse.
- type: boolean
- default: true
- requested_quantity:
- description: The quantity that was originally requested to be returned.
- nullable: true
- type: integer
- example: 1
- received_quantity:
- description: The quantity that was received in the warehouse.
- nullable: true
- type: integer
- example: 1
- reason_id:
- description: The ID of the reason for returning the item.
- nullable: true
- type: string
- example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
- reason:
- description: The details of the reason for returning the item.
- x-expandable: reason
- nullable: true
- $ref: ./ReturnReason.yaml
- note:
- description: An optional note with additional details about the Return.
- nullable: true
- type: string
- example: I didn't like it.
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/ReturnReason.yaml
deleted file mode 100644
index 28f6b23324..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ReturnReason.yaml
+++ /dev/null
@@ -1,70 +0,0 @@
-title: Return Reason
-description: >-
- A Return Reason is a value defined by an admin. It can be used on Return Items
- in order to indicate why a Line Item was returned.
-type: object
-required:
- - created_at
- - deleted_at
- - description
- - id
- - label
- - metadata
- - parent_return_reason_id
- - updated_at
- - value
-properties:
- id:
- description: The return reason's ID
- type: string
- example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
- value:
- description: The value to identify the reason by.
- type: string
- example: damaged
- label:
- description: A text that can be displayed to the Customer as a reason.
- type: string
- example: Damaged goods
- description:
- description: A description of the Reason.
- nullable: true
- type: string
- example: Items that are damaged
- parent_return_reason_id:
- description: The ID of the parent reason.
- nullable: true
- type: string
- example: null
- parent_return_reason:
- description: The details of the parent reason.
- x-expandable: parent_return_reason
- nullable: true
- type: object
- return_reason_children:
- description: The details of the child reasons.
- x-expandable: return_reason_children
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/SalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/SalesChannel.yaml
deleted file mode 100644
index 1dc2968f5c..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/SalesChannel.yaml
+++ /dev/null
@@ -1,84 +0,0 @@
-title: Sales Channel
-description: >-
- A Sales Channel is a method a business offers its products for purchase for
- the customers. For example, a Webshop can be a sales channel, and a mobile app
- can be another.
-type: object
-required:
- - created_at
- - deleted_at
- - description
- - id
- - is_disabled
- - name
- - updated_at
-properties:
- id:
- description: The sales channel's ID
- type: string
- example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
- name:
- description: The name of the sales channel.
- type: string
- example: Market
- description:
- description: The description of the sales channel.
- nullable: true
- type: string
- example: Multi-vendor market
- is_disabled:
- description: Specify if the sales channel is enabled or disabled.
- type: boolean
- default: false
- locations:
- description: The details of the stock locations related to the sales channel.
- type: array
- x-expandable: locations
- items:
- $ref: ./SalesChannelLocation.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- carts:
- description: The associated carts.
- type: array
- nullable: true
- x-expandable: carts
- x-featureFlag: medusa_v2
- items:
- type: object
- orders:
- description: The associated orders.
- type: array
- nullable: true
- x-expandable: orders
- x-featureFlag: medusa_v2
- items:
- type: object
- publishableKeys:
- description: The associated publishable API keys.
- type: array
- nullable: true
- x-expandable: publishableKeys
- items:
- type: object
diff --git a/www/apps/api-reference/specs/admin/components/schemas/SalesChannelLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/SalesChannelLocation.yaml
deleted file mode 100644
index 4936e19986..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/SalesChannelLocation.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-title: Sales Channel Stock Location
-description: This represents the association between a sales channel and a stock locations.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - location_id
- - sales_channel_id
- - updated_at
-properties:
- id:
- description: The Sales Channel Stock Location's ID
- type: string
- example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A
- sales_channel_id:
- description: The ID of the Sales Channel
- type: string
- example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
- location_id:
- description: The ID of the Location Stock.
- type: string
- sales_channel:
- description: The details of the sales channel the location is associated with.
- x-expandable: sales_channel
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/ShippingMethod.yaml
deleted file mode 100644
index 730bf052cd..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ShippingMethod.yaml
+++ /dev/null
@@ -1,119 +0,0 @@
-title: Shipping Method
-description: >-
- A Shipping Method represents a way in which an Order or Return can be shipped.
- Shipping Methods are created from a Shipping Option, but may contain
- additional details that can be necessary for the Fulfillment Provider to
- handle the shipment. If the shipping method is created for a return, it may be
- associated with a claim or a swap that the return is part of.
-type: object
-required:
- - cart_id
- - claim_order_id
- - data
- - id
- - order_id
- - price
- - return_id
- - shipping_option_id
- - swap_id
-properties:
- id:
- description: The shipping method's ID
- type: string
- example: sm_01F0YET7DR2E7CYVSDHM593QG2
- shipping_option_id:
- description: The ID of the Shipping Option that the Shipping Method is built from.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- order_id:
- description: The ID of the order that the shipping method is used in.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the shipping method is used in.
- x-expandable: order
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the shipping method is used in.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the shipping method is used in.
- x-expandable: claim_order
- nullable: true
- type: object
- cart_id:
- description: The ID of the cart that the shipping method is used in.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the shipping method is used in.
- x-expandable: cart
- nullable: true
- type: object
- swap_id:
- description: The ID of the swap that the shipping method is used in.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the shipping method is used in.
- x-expandable: swap
- nullable: true
- type: object
- return_id:
- description: The ID of the return that the shipping method is used in.
- nullable: true
- type: string
- example: null
- return_order:
- description: The details of the return that the shipping method is used in.
- x-expandable: return_order
- nullable: true
- type: object
- shipping_option:
- description: The details of the shipping option the method was created from.
- x-expandable: shipping_option
- nullable: true
- $ref: ./ShippingOption.yaml
- tax_lines:
- description: The details of the tax lines applied on the shipping method.
- type: array
- x-expandable: tax_lines
- items:
- $ref: ./ShippingMethodTaxLine.yaml
- price:
- description: >-
- The amount to charge for the Shipping Method. The currency of the price is
- defined by the Region that the Order that the Shipping Method belongs to
- is a part of.
- type: integer
- example: 200
- data:
- description: >-
- Additional data that the Fulfillment Provider needs to fulfill the
- shipment. This is used in combination with the Shipping Options data, and
- may contain information such as a drop point id.
- type: object
- example: {}
- includes_tax:
- description: Whether the shipping method price include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- subtotal:
- description: The subtotal of the shipping
- type: integer
- example: 8000
- total:
- description: The total amount of the shipping
- type: integer
- example: 8200
- tax_total:
- description: The total of tax
- type: integer
- example: 0
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/ShippingMethodTaxLine.yaml
deleted file mode 100644
index 892b8c06e0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ShippingMethodTaxLine.yaml
+++ /dev/null
@@ -1,59 +0,0 @@
-title: Shipping Method Tax Line
-description: >-
- A Shipping Method Tax Line represents the taxes applied on a shipping method
- in a cart.
-type: object
-required:
- - code
- - created_at
- - id
- - shipping_method_id
- - metadata
- - name
- - rate
- - updated_at
-properties:
- id:
- description: The line item tax line's ID
- type: string
- example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- shipping_method_id:
- description: The ID of the line item
- type: string
- example: sm_01F0YET7DR2E7CYVSDHM593QG2
- shipping_method:
- description: The details of the associated shipping method.
- x-expandable: shipping_method
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/ShippingOption.yaml
deleted file mode 100644
index fbc4d8ed41..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ShippingOption.yaml
+++ /dev/null
@@ -1,137 +0,0 @@
-title: Shipping Option
-description: >-
- A Shipping Option represents a way in which an Order or Return can be shipped.
- Shipping Options have an associated Fulfillment Provider that will be used
- when the fulfillment of an Order is initiated. Shipping Options themselves
- cannot be added to Carts, but serve as a template for Shipping Methods. This
- distinction makes it possible to customize individual Shipping Methods with
- additional information.
-type: object
-required:
- - admin_only
- - amount
- - created_at
- - data
- - deleted_at
- - id
- - is_return
- - metadata
- - name
- - price_type
- - profile_id
- - provider_id
- - region_id
- - updated_at
-properties:
- id:
- description: The shipping option's ID
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- name:
- description: >-
- The name given to the Shipping Option - this may be displayed to the
- Customer.
- type: string
- example: PostFake Standard
- region_id:
- description: The ID of the region this shipping option can be used in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this shipping option can be used in.
- x-expandable: region
- nullable: true
- type: object
- profile_id:
- description: The ID of the Shipping Profile that the shipping option belongs to.
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- profile:
- description: The details of the shipping profile that the shipping option belongs to.
- x-expandable: profile
- nullable: true
- $ref: ./ShippingProfile.yaml
- provider_id:
- description: >-
- The ID of the fulfillment provider that will be used to later to process
- the shipping method created from this shipping option and its
- fulfillments.
- type: string
- example: manual
- provider:
- description: >-
- The details of the fulfillment provider that will be used to later to
- process the shipping method created from this shipping option and its
- fulfillments.
- x-expandable: provider
- nullable: true
- $ref: ./FulfillmentProvider.yaml
- price_type:
- description: >-
- The type of pricing calculation that is used when creatin Shipping Methods
- from the Shipping Option. Can be `flat_rate` for fixed prices or
- `calculated` if the Fulfillment Provider can provide price calulations.
- type: string
- enum:
- - flat_rate
- - calculated
- example: flat_rate
- amount:
- description: >-
- The amount to charge for shipping when the Shipping Option price type is
- `flat_rate`.
- nullable: true
- type: integer
- example: 200
- is_return:
- description: Flag to indicate if the Shipping Option can be used for Return shipments.
- type: boolean
- default: false
- admin_only:
- description: >-
- Flag to indicate if the Shipping Option usage is restricted to admin
- users.
- type: boolean
- default: false
- requirements:
- description: >-
- The details of the requirements that must be satisfied for the Shipping
- Option to be available for usage in a Cart.
- type: array
- x-expandable: requirements
- items:
- $ref: ./ShippingOptionRequirement.yaml
- data:
- description: >-
- The data needed for the Fulfillment Provider to identify the Shipping
- Option.
- type: object
- example: {}
- includes_tax:
- description: Whether the shipping option price include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ShippingOptionRequirement.yaml b/www/apps/api-reference/specs/admin/components/schemas/ShippingOptionRequirement.yaml
deleted file mode 100644
index 26764f96d0..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ShippingOptionRequirement.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Shipping Option Requirement
-description: >-
- A shipping option requirement defines conditions that a Cart must satisfy for
- the Shipping Option to be available for usage in the Cart.
-type: object
-required:
- - amount
- - deleted_at
- - id
- - shipping_option_id
- - type
-properties:
- id:
- description: The shipping option requirement's ID
- type: string
- example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
- shipping_option_id:
- description: The ID of the shipping option that the requirements belong to.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the shipping option that the requirements belong to.
- x-expandable: shipping_option
- nullable: true
- type: object
- type:
- description: >-
- The type of the requirement, this defines how the value will be compared
- to the Cart's total. `min_subtotal` requirements define the minimum
- subtotal that is needed for the Shipping Option to be available, while the
- `max_subtotal` defines the maximum subtotal that the Cart can have for the
- Shipping Option to be available.
- type: string
- enum:
- - min_subtotal
- - max_subtotal
- example: min_subtotal
- amount:
- description: The amount to compare the Cart subtotal to.
- type: integer
- example: 100
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/ShippingProfile.yaml
deleted file mode 100644
index 58c9ef4558..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ShippingProfile.yaml
+++ /dev/null
@@ -1,76 +0,0 @@
-title: Shipping Profile
-description: >-
- A Shipping Profile has a set of defined Shipping Options that can be used to
- fulfill a given set of Products. For example, gift cards are shipped
- differently than physical products, so a shipping profile with the type
- `gift_card` groups together the shipping options that can only be used for
- gift cards.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - name
- - type
- - updated_at
-properties:
- id:
- description: The shipping profile's ID
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- name:
- description: >-
- The name given to the Shipping profile - this may be displayed to the
- Customer.
- type: string
- example: Default Shipping Profile
- type:
- description: >-
- The type of the Shipping Profile, may be `default`, `gift_card` or
- `custom`.
- type: string
- enum:
- - default
- - gift_card
- - custom
- example: default
- products:
- description: >-
- The details of the products that the Shipping Profile defines Shipping
- Options for. Available if the relation `products` is expanded.
- type: array
- x-expandable: products
- items:
- type: object
- shipping_options:
- description: >-
- The details of the shipping options that can be used to create shipping
- methods for the Products in the Shipping Profile.
- type: array
- x-expandable: shipping_options
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/ShippingTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/ShippingTaxRate.yaml
deleted file mode 100644
index c7b36795be..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/ShippingTaxRate.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Shipping Tax Rate
-description: This represents the tax rates applied on a shipping option.
-type: object
-required:
- - created_at
- - metadata
- - rate_id
- - shipping_option_id
- - updated_at
-properties:
- shipping_option_id:
- description: The ID of the shipping option.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the shipping option.
- x-expandable: shipping_option
- nullable: true
- $ref: ./ShippingOption.yaml
- rate_id:
- description: The ID of the associated tax rate.
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the associated tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: ./TaxRate.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/StagedJob.yaml b/www/apps/api-reference/specs/admin/components/schemas/StagedJob.yaml
deleted file mode 100644
index adc7c6beab..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/StagedJob.yaml
+++ /dev/null
@@ -1,25 +0,0 @@
-title: Staged Job
-description: A staged job resource
-type: object
-required:
- - data
- - event_name
- - id
- - options
-properties:
- id:
- description: The staged job's ID
- type: string
- example: job_01F0YET7BZTARY9MKN1SJ7AAXF
- event_name:
- description: The name of the event
- type: string
- example: order.placed
- data:
- description: Data necessary for the job
- type: object
- example: {}
- option:
- description: The staged job's option
- type: object
- example: {}
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/StockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/StockLocationAddress.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/StockLocationAddress.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddressDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddressDTO.yaml
deleted file mode 100644
index fa00e2353d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddressDTO.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-title: Stock Location Address
-description: Represents a Stock Location Address
-type: object
-required:
- - address_1
- - country_code
- - created_at
- - updated_at
-properties:
- id:
- type: string
- description: The stock location address' ID
- example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42
- address_1:
- type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
- address_2:
- type: string
- description: Stock location address' complement
- example: apartment 4432
- company:
- type: string
- description: Stock location company' name
- example: Medusa
- city:
- type: string
- description: Stock location address' city
- example: Mexico city
- country_code:
- type: string
- description: Stock location address' country
- example: MX
- phone:
- type: string
- description: Stock location address' phone number
- example: +1 555 61646
- postal_code:
- type: string
- description: Stock location address' postal code
- example: HD3-1G8
- province:
- type: string
- description: Stock location address' province
- example: Sinaloa
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddressInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddressInput.yaml
deleted file mode 100644
index 700d86deb8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/StockLocationAddressInput.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-title: Stock Location Address Input
-description: Represents a Stock Location Address Input
-type: object
-required:
- - address_1
- - country_code
-properties:
- address_1:
- type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
- address_2:
- type: string
- description: Stock location address' complement
- example: apartment 4432
- city:
- type: string
- description: Stock location address' city
- example: Mexico city
- country_code:
- type: string
- description: Stock location address' country
- example: MX
- phone:
- type: string
- description: Stock location address' phone number
- example: +1 555 61646
- postal_code:
- type: string
- description: Stock location address' postal code
- example: HD3-1G8
- province:
- type: string
- description: Stock location address' province
- example: Sinaloa
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs/admin/components/schemas/StockLocationDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationDTO.yaml
deleted file mode 100644
index e4233fd30d..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/StockLocationDTO.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Stock Location
-description: Represents a Stock Location
-type: object
-required:
- - id
- - name
- - address_id
- - created_at
- - updated_at
-properties:
- id:
- type: string
- description: The stock location's ID
- example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42
- address_id:
- type: string
- description: Stock location address' ID
- example: laddr_05B2ZE853Y6FTXWPW85NJ81A44
- name:
- type: string
- description: The name of the stock location
- example: Main Warehouse
- address:
- description: The Address of the Stock Location
- allOf:
- - $ref: ./StockLocationAddressDTO.yaml
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml b/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml
deleted file mode 100644
index 993fad1ca8..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/StockLocationExpandedDTO.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-allOf:
- - $ref: ./StockLocationDTO.yaml
- - type: object
- properties:
- sales_channels:
- description: The associated sales channels.
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Store.yaml b/www/apps/api-reference/specs/admin/components/schemas/Store.yaml
deleted file mode 100644
index e1331293bc..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Store.yaml
+++ /dev/null
@@ -1,98 +0,0 @@
-title: Store
-description: >-
- A store holds the main settings of the commerce shop. By default, only one
- store is created and used within the Medusa backend. It holds settings related
- to the name of the store, available currencies, and more.
-type: object
-required:
- - created_at
- - default_currency_code
- - default_location_id
- - id
- - invite_link_template
- - metadata
- - name
- - payment_link_template
- - swap_link_template
- - updated_at
-properties:
- id:
- description: The store's ID
- type: string
- example: store_01G1G5V21KADXNGH29BJMAJ4B4
- name:
- description: The name of the Store - this may be displayed to the Customer.
- type: string
- example: Medusa Store
- default: Medusa Store
- default_currency_code:
- description: The three character currency code that is the default of the store.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- default_currency:
- description: The details of the store's default currency.
- x-expandable: default_currency
- default: usd
- nullable: true
- $ref: ./Currency.yaml
- currencies:
- description: The details of the enabled currencies in the store.
- type: array
- x-expandable: currencies
- items:
- $ref: ./Currency.yaml
- swap_link_template:
- description: >-
- A template to generate Swap links from. Use {{cart_id}} to include the
- Swap's `cart_id` in the link.
- nullable: true
- type: string
- example: null
- payment_link_template:
- description: >-
- A template to generate Payment links from. Use {{cart_id}} to include the
- payment's `cart_id` in the link.
- nullable: true
- type: string
- example: null
- invite_link_template:
- description: A template to generate Invite links from
- nullable: true
- type: string
- example: null
- default_location_id:
- description: The location ID the store is associated with.
- nullable: true
- type: string
- example: null
- default_sales_channel_id:
- description: The ID of the store's default sales channel.
- nullable: true
- type: string
- example: null
- default_sales_channel:
- description: The details of the store's default sales channel.
- x-expandable: default_sales_channel
- nullable: true
- $ref: ./SalesChannel.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/StorePostCartsCartTaxesReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePostCartsCartTaxesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/StorePostCartsCartTaxesReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/StorePostCartsCartTaxesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/Swap.yaml b/www/apps/api-reference/specs/admin/components/schemas/Swap.yaml
deleted file mode 100644
index 7e00bf1687..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/Swap.yaml
+++ /dev/null
@@ -1,186 +0,0 @@
-title: Swap
-description: >-
- A swap can be created when a Customer wishes to exchange Products that they
- have purchased with different Products. It consists of a Return of previously
- purchased Products and a Fulfillment of new Products. It also includes
- information on any additional payment or refund required based on the
- difference between the exchanged products.
-type: object
-required:
- - allow_backorder
- - canceled_at
- - cart_id
- - confirmed_at
- - created_at
- - deleted_at
- - difference_due
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - order_id
- - payment_status
- - shipping_address_id
- - updated_at
-properties:
- id:
- description: The swap's ID
- type: string
- example: swap_01F0YET86Y9G92D3YDR9Y6V676
- fulfillment_status:
- description: The status of the Fulfillment of the Swap.
- type: string
- enum:
- - not_fulfilled
- - fulfilled
- - shipped
- - partially_shipped
- - canceled
- - requires_action
- example: not_fulfilled
- payment_status:
- description: >-
- The status of the Payment of the Swap. The payment may either refer to the
- refund of an amount or the authorization of a new amount.
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - confirmed
- - canceled
- - difference_refunded
- - partially_refunded
- - refunded
- - requires_action
- example: not_paid
- order_id:
- description: The ID of the order that the swap belongs to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the swap belongs to.
- x-expandable: order
- nullable: true
- type: object
- additional_items:
- description: >-
- The details of the new products to send to the customer, represented as
- line items.
- type: array
- x-expandable: additional_items
- items:
- $ref: ./LineItem.yaml
- return_order:
- description: >-
- The details of the return that belongs to the swap, which holds the
- details on the items being returned.
- x-expandable: return_order
- nullable: true
- type: object
- fulfillments:
- description: >-
- The details of the fulfillments that are used to send the new items to the
- customer.
- x-expandable: fulfillments
- type: array
- items:
- type: object
- payment:
- description: >-
- The details of the additional payment authorized by the customer when
- `difference_due` is positive.
- x-expandable: payment
- nullable: true
- type: object
- difference_due:
- description: >-
- The difference amount between the order’s original total and the new total
- imposed by the swap. If its value is negative, a refund must be issues to
- the customer. If it's positive, additional payment must be authorized by
- the customer. Otherwise, no payment processing is required.
- nullable: true
- type: integer
- example: 0
- shipping_address_id:
- description: >-
- The Address to send the new Line Items to - in most cases this will be the
- same as the shipping address on the Order.
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address that the new items should be sent to.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- shipping_methods:
- description: >-
- The details of the shipping methods used to fulfill the additional items
- purchased.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- cart_id:
- description: The ID of the cart that the customer uses to complete the swap.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the customer uses to complete the swap.
- x-expandable: cart
- nullable: true
- type: object
- confirmed_at:
- description: The date with timezone at which the Swap was confirmed by the Customer.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date with timezone at which the Swap was canceled.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: If set to true, no notification will be sent related to this swap
- nullable: true
- type: boolean
- example: false
- allow_backorder:
- description: If true, swaps can be completed with items out of stock
- type: boolean
- default: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the swap in case
- of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/TaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/TaxLine.yaml
deleted file mode 100644
index cbdb672a17..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/TaxLine.yaml
+++ /dev/null
@@ -1,47 +0,0 @@
-title: Tax Line
-description: A tax line represents the taxes amount applied to a line item.
-type: object
-required:
- - code
- - created_at
- - id
- - metadata
- - name
- - rate
- - updated_at
-properties:
- id:
- description: The tax line's ID
- type: string
- example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/TaxProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/TaxProvider.yaml
deleted file mode 100644
index 0abb0ed394..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/TaxProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Tax Provider
-description: >-
- A tax provider represents a tax service installed in the Medusa backend,
- either through a plugin or backend customizations. It holds the tax service's
- installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the tax provider as given by the tax service.
- type: string
- example: manual
- is_installed:
- description: >-
- Whether the tax service is installed in the current version. If a tax
- service is no longer installed, the `is_installed` attribute is set to
- `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/admin/components/schemas/TaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/TaxRate.yaml
deleted file mode 100644
index aaf91c7e76..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/TaxRate.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-title: Tax Rate
-description: >-
- A Tax Rate can be used to define a custom rate to charge on specified
- products, product types, and shipping options within a given region.
-type: object
-required:
- - code
- - created_at
- - id
- - metadata
- - name
- - rate
- - region_id
- - updated_at
-properties:
- id:
- description: The tax rate's ID
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- rate:
- description: The numeric rate to charge
- nullable: true
- type: number
- example: 10
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- region_id:
- description: The ID of the region that the rate belongs to.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region that the rate belongs to.
- x-expandable: region
- nullable: true
- type: object
- products:
- description: The details of the products that belong to this tax rate.
- type: array
- x-expandable: products
- items:
- $ref: ./Product.yaml
- product_types:
- description: The details of the product types that belong to this tax rate.
- type: array
- x-expandable: product_types
- items:
- $ref: ./ProductType.yaml
- shipping_options:
- description: The details of the shipping options that belong to this tax rate.
- type: array
- x-expandable: shipping_options
- items:
- $ref: ./ShippingOption.yaml
- product_count:
- description: The count of products
- type: integer
- example: 10
- product_type_count:
- description: The count of product types
- type: integer
- example: 2
- shipping_option_count:
- description: The count of shipping options
- type: integer
- example: 1
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/TrackingLink.yaml b/www/apps/api-reference/specs/admin/components/schemas/TrackingLink.yaml
deleted file mode 100644
index 2da6690dae..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/TrackingLink.yaml
+++ /dev/null
@@ -1,72 +0,0 @@
-title: Tracking Link
-description: >-
- A tracking link holds information about tracking numbers for a Fulfillment.
- Tracking Links can optionally contain a URL that can be visited to see the
- status of the shipment. Typically, the tracking link is provided from the
- third-party service integrated through the used fulfillment provider.
-type: object
-required:
- - created_at
- - deleted_at
- - fulfillment_id
- - id
- - idempotency_key
- - metadata
- - tracking_number
- - updated_at
- - url
-properties:
- id:
- description: The tracking link's ID
- type: string
- example: tlink_01G8ZH853Y6TFXWPG5EYE81X63
- url:
- description: The URL at which the status of the shipment can be tracked.
- nullable: true
- type: string
- format: uri
- tracking_number:
- description: The tracking number given by the shipping carrier.
- type: string
- format: RH370168054CN
- fulfillment_id:
- description: The ID of the fulfillment that the tracking link belongs to.
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- fulfillment:
- description: The details of the fulfillment that the tracking link belongs to.
- x-expandable: fulfillment
- nullable: true
- type: object
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a process in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateAddress.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateApiKey.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateApiKey.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateApiKey.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateCartData.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProduct.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProduct.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateProduct.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProductCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProductCollection.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProductCollection.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateProductCollection.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProductOption.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProductOption.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateProductOption.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateProductVariant.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateProductVariant.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateProductVariant.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpdateRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateRegion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpdateRegion.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpdateRegion.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateStockLocationInput.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateStockLocationInput.yaml
deleted file mode 100644
index 6b14b20a0e..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/UpdateStockLocationInput.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-title: Update Stock Location Input
-description: Represents the Input to update a Stock Location
-type: object
-properties:
- name:
- type: string
- description: The stock location name
- address_id:
- type: string
- description: The Stock location address ID
- address:
- description: Stock location address object
- allOf:
- - $ref: ./StockLocationAddressInput.yaml
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/UpsertProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpsertProductVariant.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/UpsertProductVariant.yaml
rename to www/apps/api-reference/specs/admin/components/schemas/UpsertProductVariant.yaml
diff --git a/www/apps/api-reference/specs/admin/components/schemas/User.yaml b/www/apps/api-reference/specs/admin/components/schemas/User.yaml
deleted file mode 100644
index 33f313d896..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/User.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-title: User
-description: A User is an administrator who can manage store settings and data.
-type: object
-required:
- - api_token
- - created_at
- - deleted_at
- - email
- - first_name
- - id
- - last_name
- - metadata
- - role
- - updated_at
-properties:
- id:
- description: The user's ID
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- role:
- description: The user's role. These roles don't provide any different privileges.
- type: string
- enum:
- - admin
- - member
- - developer
- default: member
- email:
- description: The email of the User
- type: string
- format: email
- first_name:
- description: The first name of the User
- nullable: true
- type: string
- example: Levi
- last_name:
- description: The last name of the User
- nullable: true
- type: string
- example: Bogan
- api_token:
- description: An API token associated with the user.
- nullable: true
- type: string
- example: null
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml b/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml
deleted file mode 100644
index 816d5fcbfb..0000000000
--- a/www/apps/api-reference/specs/admin/components/schemas/VariantInventory.yaml
+++ /dev/null
@@ -1,31 +0,0 @@
-type: object
-required:
- - id
- - inventory
- - sales_channel_availability
-properties:
- id:
- description: the ID of the variant
- type: string
- inventory:
- description: The inventory details.
- $ref: ./ResponseInventoryItem.yaml
- sales_channel_availability:
- type: array
- description: Details about the variant's inventory availability in sales channels.
- items:
- type: object
- required:
- - channel_name
- - channel_id
- - available_quantity
- properties:
- channel_name:
- description: Sales channel's name
- type: string
- channel_id:
- description: Sales channel's ID
- type: string
- available_quantity:
- description: Available quantity in the sales channel
- type: number
diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml
index 5930cedad7..bdf80faa33 100644
--- a/www/apps/api-reference/specs/admin/openapi.full.yaml
+++ b/www/apps/api-reference/specs/admin/openapi.full.yaml
@@ -1,6 +1,6 @@
openapi: 3.0.0
info:
- version: 1.0.0
+ version: 2.0.0
title: Medusa Admin API
license:
name: MIT
@@ -9,24 +9,9 @@ servers:
- url: http://localhost:9000
- url: https://api.medusa-commerce.com
tags:
- - name: Apps Oauth
- description: |
- Some plugins may require to authenticate with third-party services and store authentication details, such as the authentication token. To do that, they can create an Oauth provider within the plugin that handles the authentication.
- The Apps Oauth API Routes allows admins to manage and generate token for an app using its oauth provider.
- - name: Auth
- description: |
- Authentication API Routes allow admin users to manage their session, such as login or log out.
- When an admin user is logged in, the cookie header is set indicating the admin's login session.
- externalDocs:
- description: How to implement user profiles
- url: https://docs.medusajs.com/modules/users/admin/manage-profile
- - name: Batch Jobs
- description: |
- A batch job is a task that is performed by the Medusa backend asynchronusly. For example, the Import Product feature is implemented using batch jobs.
- Batch Job API Routes allow admins to manage the batch jobs and their state.
- externalDocs:
- description: How to import products
- url: https://docs.medusajs.com/modules/products/admin/import-products
+ - name: Api Keys
+ - name: Campaigns
+ - name: Collections
- name: Currencies
description: |
A store can use unlimited currencies, and each region must be associated with at least one currency.
@@ -47,26 +32,7 @@ tags:
externalDocs:
description: How to manage customers
url: https://docs.medusajs.com/modules/customers/admin/manage-customers
- - name: Discounts
- description: |
- Admins can create discounts with conditions and rules, providing them with advanced settings for variety of cases.
- The Discount API Routes can be used to manage discounts, their conditions, resources, and more.
- externalDocs:
- description: How to manage discounts
- url: https://docs.medusajs.com/modules/discounts/admin/manage-discounts
- - name: Draft Orders
- description: |
- A draft order is an order created manually by the admin. It allows admins to create orders without direct involvement from the customer.
- externalDocs:
- description: How to manage draft orders
- url: https://docs.medusajs.com/modules/orders/admin/manage-draft-orders
- - name: Gift Cards
- description: |
- Admins can create gift cards and send them directly to customers, specifying options like their balance, region, and more.
- These gift cards are different than the saleable gift cards in a store, which are created and managed through Product API Routes.
- externalDocs:
- description: How to manage gift cards
- url: https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-custom-gift-cards
+ - name: Fulfillment
- name: Inventory Items
description: |
Inventory items, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), can be used to manage the inventory of saleable items in your store.
@@ -79,29 +45,6 @@ tags:
externalDocs:
description: How to manage invites
url: https://docs.medusajs.com/modules/users/admin/manage-invites
- - name: Notes
- description: |
- Notes are created by admins and can be associated with any resource. For example, an admin can add a note to an order for additional details or remarks.
- - name: Notifications
- description: |
- Notifications are sent to customers to inform them of new updates. For example, a notification can be sent to the customer when their order is place or its state is updated.
- The notification's type, such as an email or SMS, is determined by the notification provider installed on the Medusa backend.
- - name: Order Edits
- description: |
- An admin can edit an order to remove, add, or update an item's quantity. When an admin edits an order, they're stored as an `OrderEdit`.
- externalDocs:
- description: How to edit an order
- url: https://docs.medusajs.com/modules/orders/admin/edit-order
- - name: Orders
- description: |
- Orders are purchases made by customers, typically through a storefront using the Store API. Draft orders created by the admin are also transformed to an Order once the payment is captured.
- Managing orders include managing fulfillment, payment, claims, reservations, and more.
- externalDocs:
- description: How to manage orders
- url: https://docs.medusajs.com/modules/orders/admin/manage-orders
- - name: Payment Collections
- description: |
- A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments.
- name: Payments
description: |
A payment can be related to an order, swap, return, or more. It can be captured or refunded.
@@ -111,45 +54,14 @@ tags:
externalDocs:
description: How to manage price lists
url: https://docs.medusajs.com/modules/price-lists/admin/manage-price-lists
- - name: Product Categories
- description: |
- Products can be categoriezed into categories. A product can be added into more than one category.
- externalDocs:
- description: How to manage product categories
- url: https://docs.medusajs.com/modules/products/admin/manage-categories
- - name: Product Collections
- description: |
- A product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection.
- - name: Product Tags
- description: |
- Product tags are string values created when you create or update a product with a new tag.
- Products can have more than one tag, and products can share tags. This allows admins to associate products to similar tags that can be used to filter products.
- - name: Product Types
- description: |
- Product types are string values created when you create or update a product with a new type.
- Products can have one type, and products can share types. This allows admins to associate products with a type that can be used to filter products.
- - name: Product Variants
- description: |
- Product variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product.
- Product variants can be managed through the Products API Routes.
- externalDocs:
- description: How to manage product variants
- url: https://docs.medusajs.com/modules/products/admin/manage-products#manage-product-variants
+ - name: Pricing
- name: Products
description: |
Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/admin/manage-gift-cards#manage-gift-card-product) in a store.
externalDocs:
description: How to manage products
url: https://docs.medusajs.com/modules/products/admin/manage-products
- - name: Publishable API Keys
- description: |
- Publishable API Keys can be used to scope Store API calls with an API key, determining what resources are retrieved when querying the API.
- For example, a publishable API key can be associated with one or more sales channels. When it is passed in the header of a request to the List Product store API Route,
- the sales channels are inferred from the key and only products associated with those sales channels are retrieved.
- Admins can manage publishable API keys and their associated resources. Currently, only Sales Channels are supported as a resource.
- externalDocs:
- description: How to manage publishable API keys
- url: https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys
+ - name: Promotions
- name: Regions
description: |
Regions are different countries or geographical regions that the commerce store serves customers in.
@@ -157,27 +69,6 @@ tags:
externalDocs:
description: How to manage regions
url: https://docs.medusajs.com/modules/regions-and-currencies/admin/manage-regions
- - name: Reservations
- description: |
- Reservations, provided by the [Inventory Module](https://docs.medusajs.com/modules/multiwarehouse/inventory-module), are quantities of an item that are reserved, typically when an order is placed but not yet fulfilled.
- Reservations can be associated with any resources, but commonly with line items of an order.
- externalDocs:
- description: How to manage item allocations in orders
- url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-item-allocations-in-orders
- - name: Return Reasons
- description: |
- Return reasons are key-value pairs that are used to specify why an order return is being created.
- Admins can manage available return reasons, and they can be used by both admins and customers when creating a return.
- externalDocs:
- description: How to manage return reasons
- url: https://docs.medusajs.com/modules/orders/admin/manage-returns#manage-return-reasons
- - name: Returns
- description: |
- A return can be created by a customer or an admin to return items in an order.
- Admins can manage these returns and change their state.
- externalDocs:
- description: How to manage returns
- url: https://docs.medusajs.com/modules/orders/admin/manage-returns
- name: Sales Channels
description: |
A sales channel indicates a channel where products can be sold in. For example, a webshop or a mobile app.
@@ -185,84 +76,43 @@ tags:
externalDocs:
description: How to manage sales channels
url: https://docs.medusajs.com/modules/sales-channels/admin/manage
- - name: Shipping Options
- description: |
- A shipping option is used to define the available shipping methods during checkout or when creating a return.
- Admins can create an unlimited number of shipping options, each associated with a shipping profile and fulfillment provider, among other resources.
- externalDocs:
- description: Shipping Option architecture
- url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
- - name: Shipping Profiles
- description: |
- A shipping profile is used to group products that can be shipped in the same manner.
- They are created by the admin and they're not associated with a fulfillment provider.
- externalDocs:
- description: Shipping Profile architecture
- url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-profile
- name: Stock Locations
- description: |
- A stock location, provided by the [Stock Location module](https://docs.medusajs.com/modules/multiwarehouse/stock-location-module), indicates a physical address that stock-kept items, such as physical products, can be stored in.
- An admin can create and manage available stock locations.
- externalDocs:
- description: How to manage stock locations.
- url: https://docs.medusajs.com/modules/multiwarehouse/admin/manage-stock-locations
- - name: Store
- description: |
- A store indicates the general configurations and details about the commerce store. By default, there's only one store in the Medusa backend.
- Admins can manage the store and its details or configurations.
- - name: Swaps
- description: |
- A swap is created by a customer or an admin to exchange an item with a new one.
- Creating a swap implicitely includes creating a return for the item being exchanged.
- externalDocs:
- description: How to manage swaps
- url: https://docs.medusajs.com/modules/orders/admin/manage-swaps
+ - name: Stores
- name: Tax Rates
description: |
Each region has at least a default tax rate. Admins can create and manage additional tax rates that can be applied for certain conditions, such as for specific product types.
externalDocs:
description: How to manage tax rates
url: https://docs.medusajs.com/modules/taxes/admin/manage-tax-rates
- - name: Uploads
- description: |
- The upload API Routes are used to upload any type of resources. For example, they can be used to upload CSV files that are used to import products into the store.
- externalDocs:
- description: How to upload CSV file when importing a product.
- url: https://docs.medusajs.com/modules/products/admin/import-products#1-upload-csv-file
+ - name: Tax Regions
- name: Users
description: |
A store can have more than one user, each having the same privileges. Admins can manage users, their passwords, and more.
externalDocs:
description: How to manage users
url: https://docs.medusajs.com/modules/users/admin/manage-users
+ - name: Workflows Executions
paths:
- /admin/apps:
+ /admin/api-keys:
get:
- operationId: GetApps
- summary: List Applications
- description: Retrieve a list of applications registered in the Medusa backend.
+ operationId: GetApiKeys
+ summary: List Api Keys
+ description: Retrieve a list of api keys. The api keys can be filtered by fields such as `id`. The api keys can also be sorted or paginated.
x-authenticated: true
- x-codegen:
- method: list
- x-codeSamples:
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/admin/apps' \
- -H 'x-medusa-access-token: {api_token}'
+ parameters: []
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl '{backend_url}/admin/api-keys' \
+ -H 'x-medusa-access-token: {api_token}'
tags:
- - Apps Oauth
+ - Api Keys
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AdminAppsListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -275,44 +125,358 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
- /admin/apps/authorizations:
+ requestBody:
+ content:
+ application/json:
+ schema: {}
post:
- operationId: PostApps
- summary: Generate Token for App
- description: Use an app's Oauth provider to generate and store a new token for authentication.
+ operationId: PostApiKeys
+ summary: Create Api Key
+ description: Create a api key.
x-authenticated: true
+ parameters: []
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl -X POST '{backend_url}/admin/api-keys' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Api Keys
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ /admin/api-keys/{id}:
+ get:
+ operationId: GetApiKeysId
+ summary: Get a Api Key
+ description: Retrieve a api key by its ID. You can expand the api key's relations or select the fields that should be returned.
+ x-authenticated: true
+ parameters:
+ - name: id
+ in: path
+ description: The api key's ID.
+ required: true
+ schema:
+ type: string
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl '{backend_url}/admin/api-keys/{id}' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Api Keys
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ post:
+ operationId: PostApiKeysId
+ summary: Update a Api Key
+ description: Update a api key's details.
+ x-authenticated: true
+ parameters:
+ - name: id
+ in: path
+ description: The api key's ID.
+ required: true
+ schema:
+ type: string
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl -X POST '{backend_url}/admin/api-keys/{id}' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Api Keys
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ delete:
+ operationId: DeleteApiKeysId
+ summary: Delete a Api Key
+ description: Delete a api key.
+ x-authenticated: true
+ parameters:
+ - name: id
+ in: path
+ description: The api key's ID.
+ required: true
+ schema:
+ type: string
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl -X DELETE '{backend_url}/admin/api-keys/{id}' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Api Keys
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ /admin/api-keys/{id}/revoke:
+ post:
+ operationId: PostApiKeysIdRevoke
+ summary: Add Revokes to Api Key
+ description: Add a list of revokes to a api key.
+ x-authenticated: true
+ parameters:
+ - name: id
+ in: path
+ description: The api key's ID.
+ required: true
+ schema:
+ type: string
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl -X POST '{backend_url}/admin/api-keys/{id}/revoke' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Api Keys
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ /admin/campaigns:
+ get:
+ operationId: GetCampaigns
+ summary: List Campaigns
+ description: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated.
+ x-authenticated: true
+ parameters: []
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl '{backend_url}/admin/campaigns' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Campaigns
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ post:
+ operationId: PostCampaigns
+ summary: Create Campaign
+ description: Create a campaign.
+ x-authenticated: true
+ parameters: []
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl -X POST '{backend_url}/admin/campaigns' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Campaigns
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ /admin/campaigns/{id}:
+ get:
+ operationId: GetCampaignsId
+ summary: Get a Campaign
+ description: Retrieve a campaign by its ID. You can expand the campaign's relations or select the fields that should be returned.
+ x-authenticated: true
+ parameters:
+ - name: id
+ in: path
+ description: The campaign's ID.
+ required: true
+ schema:
+ type: string
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source: |-
+ curl '{backend_url}/admin/campaigns/{id}' \
+ -H 'x-medusa-access-token: {api_token}'
+ tags:
+ - Campaigns
+ responses:
+ '400':
+ $ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
+ '404':
+ $ref: '#/components/responses/not_found_error'
+ '409':
+ $ref: '#/components/responses/invalid_state_error'
+ '422':
+ $ref: '#/components/responses/invalid_request_error'
+ '500':
+ $ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+ post:
+ operationId: PostCampaignsId
+ summary: Update a Campaign
+ description: Update a campaign's details.
+ x-authenticated: true
+ parameters:
+ - name: id
+ in: path
+ description: The campaign's ID.
+ required: true
+ schema:
+ type: string
+ security:
+ - api_token: []
+ - cookie_auth: []
+ - jwt_token: []
requestBody:
content:
application/json:
schema:
- $ref: '#/components/schemas/AdminPostAppsReq'
- x-codegen:
- method: authorize
+ $ref: '#/components/schemas/AdminPostCampaignsReq'
x-codeSamples:
- lang: Shell
label: cURL
- source: |
- curl -X POST '{backend_url}/admin/apps/authorizations' \
+ source: |-
+ curl -X POST '{backend_url}/admin/campaigns/{id}' \
-H 'x-medusa-access-token: {api_token}' \
-H 'Content-Type: application/json' \
--data-raw '{
- "application_name": "example",
- "state": "ready",
- "code": "token"
+ "name": "Moriah"
}'
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
tags:
- - Apps Oauth
+ - Campaigns
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AdminAppsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -325,204 +489,31 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
- /admin/auth:
- get:
- operationId: GetAuth
- summary: Get Current User
- x-authenticated: true
- description: Get the currently logged in user's details.
- x-codegen:
- method: getSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.auth.getSession()
- .then(({ user }) => {
- console.log(user.id);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useAdminGetSession } from "medusa-react"
-
- const Profile = () => {
- const { user, isLoading } = useAdminGetSession()
-
- return (
-
- )
- }
-
- export default ProductTypes
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/admin/product-types' \
- -H 'x-medusa-access-token: {api_token}'
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Product Types
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AdminProductTypesListRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -15818,279 +2940,27 @@ paths:
get:
operationId: GetProducts
summary: List Products
- description: Retrieve a list of products. The products can be filtered by fields such as `q` or `status`. The products can also be sorted or paginated.
+ description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
x-authenticated: true
- parameters:
- - in: query
- name: q
- description: term to search products' title, description, variants' title and sku, and collections' title.
- schema:
- type: string
- - in: query
- name: discount_condition_id
- description: Filter by the ID of a discount condition. Only products that this discount condition is applied to will be retrieved.
- schema:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by product IDs.
- schema:
- oneOf:
- - type: string
- description: ID of the product.
- - type: array
- items:
- type: string
- description: ID of a product.
- - in: query
- name: status
- style: form
- explode: false
- description: Filter by status.
- schema:
- type: array
- items:
- type: string
- enum:
- - draft
- - proposed
- - published
- - rejected
- - in: query
- name: collection_id
- style: form
- explode: false
- description: Filter by product collection IDs. Only products that are associated with the specified collections will be retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: tags
- style: form
- explode: false
- description: Filter by product tag IDs. Only products that are associated with the specified tags will be retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: price_list_id
- style: form
- explode: false
- description: Filter by IDs of price lists. Only products that these price lists are applied to will be retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: sales_channel_id
- style: form
- explode: false
- description: Filter by sales channel IDs. Only products that are available in the specified sales channels will be retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: type_id
- style: form
- explode: false
- description: Filter by product type IDs. Only products that are associated with the specified types will be retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: category_id
- style: form
- explode: false
- description: Filter by product category IDs. Only products that are associated with the specified categories will be retrieved.
- schema:
- type: array
- x-featureFlag: product_categories
- items:
- type: string
- - in: query
- name: include_category_children
- style: form
- explode: false
- description: whether to include product category children when filtering by `category_id`
- schema:
- type: boolean
- x-featureFlag: product_categories
- - in: query
- name: title
- description: Filter by title.
- schema:
- type: string
- - in: query
- name: description
- description: Filter by description.
- schema:
- type: string
- - in: query
- name: handle
- description: Filter by handle.
- schema:
- type: string
- - in: query
- name: is_giftcard
- description: Whether to retrieve gift cards or regular products.
- schema:
- type: boolean
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: deleted_at
- description: Filter by a deletion date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: offset
- description: The number of products to skip when retrieving the products.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of products returned.
- schema:
- type: integer
- default: 50
- - in: query
- name: expand
- description: Comma-separated relations that should be expanded in the returned products.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned products.
- schema:
- type: string
- - in: query
- name: order
- description: A product field to sort-order the retrieved products by.
- schema:
- type: string
- x-codegen:
- method: list
- queryParams: AdminGetProductsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.products.list()
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useAdminProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useAdminProducts()
-
- return (
-
- )
- }
-
- export default Swap
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/admin/swaps/{id}' \
- -H 'x-medusa-access-token: {api_token}'
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Swaps
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/AdminSwapsRes'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -24069,224 +4812,30 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
/admin/tax-rates:
get:
operationId: GetTaxRates
summary: List Tax Rates
- description: Retrieve a list of Tax Rates. The tax rates can be filtered by fields such as `name` or `rate`. The tax rates can also be paginated.
+ description: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated.
x-authenticated: true
- parameters:
- - in: query
- name: name
- description: Filter by name.
- schema:
- type: string
- - in: query
- name: region_id
- style: form
- explode: false
- description: Filter by Region IDs
- schema:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- - in: query
- name: code
- description: Filter by code.
- schema:
- type: string
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: deleted_at
- description: Filter by a deletion date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: rate
- style: form
- explode: false
- description: Filter by Rate
- schema:
- oneOf:
- - type: number
- - type: object
- properties:
- lt:
- type: number
- description: filter by rates less than this number
- gt:
- type: number
- description: filter by rates greater than this number
- lte:
- type: number
- description: filter by rates less than or equal to this number
- gte:
- type: number
- description: filter by rates greater than or equal to this number
- - in: query
- name: q
- description: Term used to search tax rates by name.
- schema:
- type: string
- - in: query
- name: order
- description: A tax rate field to sort-order the retrieved tax rates by.
- schema:
- type: string
- - in: query
- name: offset
- description: The number of tax rates to skip when retrieving the tax rates.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of tax rates returned.
- schema:
- type: integer
- default: 50
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned tax rate.
- style: form
- explode: false
- schema:
- type: array
- items:
- type: string
- - in: query
- name: expand
- description: Comma-separated relations that should be expanded in the returned tax rate.
- style: form
- explode: false
- schema:
- type: array
- items:
- type: string
- x-codegen:
- method: list
- queryParams: AdminGetTaxRatesParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.admin.taxRates.list()
- .then(({ tax_rates, limit, offset, count }) => {
- console.log(tax_rates.length);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useAdminTaxRates } from "medusa-react"
-
- const TaxRates = () => {
- const {
- tax_rates,
- isLoading
- } = useAdminTaxRates()
-
- return (
-
- )
-}
-
-export default Swap
diff --git a/www/apps/api-reference/specs/store/components/schemas/Address.yaml b/www/apps/api-reference/specs/store/components/schemas/Address.yaml
deleted file mode 100644
index e0aee13932..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Address.yaml
+++ /dev/null
@@ -1,119 +0,0 @@
-title: Address
-description: >-
- An address is used across the Medusa backend within other schemas and object
- types. For example, a customer's billing and shipping addresses both use the
- Address entity.
-type: object
-required:
- - address_1
- - address_2
- - city
- - company
- - country_code
- - created_at
- - customer_id
- - deleted_at
- - first_name
- - id
- - last_name
- - metadata
- - phone
- - postal_code
- - province
- - updated_at
-properties:
- id:
- type: string
- description: ID of the address
- example: addr_01G8ZC9VS1XVE149MGH2J7QSSH
- customer_id:
- description: ID of the customer this address belongs to
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: Available if the relation `customer` is expanded.
- nullable: true
- type: object
- company:
- description: Company name
- nullable: true
- type: string
- example: Acme
- first_name:
- description: First name
- nullable: true
- type: string
- example: Arno
- last_name:
- description: Last name
- nullable: true
- type: string
- example: Willms
- address_1:
- description: Address line 1
- nullable: true
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- nullable: true
- type: string
- example: Suite 369
- city:
- description: City
- nullable: true
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- nullable: true
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- country:
- description: A country object.
- x-expandable: country
- nullable: true
- $ref: ./Country.yaml
- province:
- description: Province
- nullable: true
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- nullable: true
- type: string
- example: 72093
- phone:
- description: Phone Number
- nullable: true
- type: string
- example: 16128234334802
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/AddressCreatePayload.yaml b/www/apps/api-reference/specs/store/components/schemas/AddressCreatePayload.yaml
deleted file mode 100644
index 1094c0f176..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/AddressCreatePayload.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-type: object
-description: Address fields used when creating an address.
-required:
- - first_name
- - last_name
- - address_1
- - city
- - country_code
- - postal_code
-properties:
- first_name:
- description: First name
- type: string
- example: Arno
- last_name:
- description: Last name
- type: string
- example: Willms
- phone:
- type: string
- description: Phone Number
- example: 16128234334802
- company:
- type: string
- address_1:
- description: Address line 1
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- type: string
- example: Suite 369
- city:
- description: City
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- province:
- description: Province
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- type: string
- example: 72093
- metadata:
- type: object
- example:
- car: white
- description: An optional key-value map with additional details
diff --git a/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml b/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml
deleted file mode 100644
index 826bf11526..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/AddressPayload.yaml
+++ /dev/null
@@ -1,51 +0,0 @@
-type: object
-description: Address fields used when creating/updating an address.
-properties:
- first_name:
- description: First name
- type: string
- example: Arno
- last_name:
- description: Last name
- type: string
- example: Willms
- phone:
- type: string
- description: Phone Number
- example: 16128234334802
- company:
- type: string
- description: Company
- address_1:
- description: Address line 1
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- type: string
- example: Suite 369
- city:
- description: City
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- type: string
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- province:
- description: Province
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- type: string
- example: 72093
- metadata:
- type: object
- example:
- car: white
- description: An optional key-value map with additional details
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminDeletePricingRuleTypesRuleTypeReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminGetPricingRuleTypesParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminGetPricingRuleTypesParams.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesParams.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminGetPricingRuleTypesRuleTypeParams.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminGetProductsParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetProductsParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminGetProductsParams.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminGetProductsParams.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminGetPromotionsParams.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGetPromotionsParams.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminGetPromotionsParams.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminGetPromotionsParams.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostCampaignsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCampaignsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostCampaignsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostCampaignsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostCustomerGroupsGroupCustomersBatchReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchAddReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsInventoryItemReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsLevelReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsItemLocationLevelsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInventoryItemsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostInventoryItemsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostInvitesInviteAcceptReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostInvitesInviteAcceptReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostInvitesInviteAcceptReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPaymentsCapturesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsCapturesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPaymentsCapturesReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsCapturesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPaymentsRefundsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsRefundsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPaymentsRefundsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPaymentsRefundsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchAddReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListPricesBatchRemoveReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostPriceListsPriceListReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsPriceListReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPriceListsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPriceListsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPriceListsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPricingRuleTypesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPricingRuleTypesReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPricingRuleTypesRuleTypeReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchAddReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchRemoveReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostPromotionsPromotionRulesBatchUpdateReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostStockLocationsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostStockLocationsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostStockLocationsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostStockLocationsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRatesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRatesReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminPostTaxRatesTaxRateReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRatesTaxRateRulesReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostTaxRegionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRegionsReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostTaxRegionsReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostTaxRegionsReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsAsyncResponseReq.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/AdminPostWorkflowsRunReq.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsRunReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/AdminPostWorkflowsRunReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminPostWorkflowsRunReq.yaml
diff --git a/www/apps/api-reference/specs-v2/admin/components/schemas/AdminUpdateUserRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUserRequest.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/admin/components/schemas/AdminUpdateUserRequest.yaml
rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateUserRequest.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/ApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/ApplicationMethod.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/ApplicationMethod.yaml
rename to www/apps/api-reference/specs/store/components/schemas/ApplicationMethod.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/ApplicationMethodsMethodPostReq.yaml b/www/apps/api-reference/specs/store/components/schemas/ApplicationMethodsMethodPostReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/ApplicationMethodsMethodPostReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/ApplicationMethodsMethodPostReq.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/BatchJob.yaml b/www/apps/api-reference/specs/store/components/schemas/BatchJob.yaml
deleted file mode 100644
index a70156fe2c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/BatchJob.yaml
+++ /dev/null
@@ -1,171 +0,0 @@
-title: Batch Job
-description: >-
- A Batch Job indicates an asynchronus task stored in the Medusa backend. Its
- status determines whether it has been executed or not.
-type: object
-required:
- - canceled_at
- - completed_at
- - confirmed_at
- - context
- - created_at
- - created_by
- - deleted_at
- - dry_run
- - failed_at
- - id
- - pre_processed_at
- - processing_at
- - result
- - status
- - type
- - updated_at
-properties:
- id:
- description: The unique identifier for the batch job.
- type: string
- example: batch_01G8T782965PYFG0751G0Z38B4
- type:
- description: The type of batch job.
- type: string
- enum:
- - product-import
- - product-export
- status:
- description: The status of the batch job.
- type: string
- enum:
- - created
- - pre_processed
- - confirmed
- - processing
- - completed
- - canceled
- - failed
- default: created
- created_by:
- description: The unique identifier of the user that created the batch job.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- created_by_user:
- description: The details of the user that created the batch job.
- x-expandable: created_by_user
- nullable: true
- $ref: ./User.yaml
- context:
- description: >-
- The context of the batch job, the type of the batch job determines what
- the context should contain.
- nullable: true
- type: object
- example:
- shape:
- prices:
- - region: null
- currency_code: eur
- dynamicImageColumnCount: 4
- dynamicOptionColumnCount: 2
- list_config:
- skip: 0
- take: 50
- order:
- created_at: DESC
- relations:
- - variants
- - variant.prices
- - images
- dry_run:
- description: Specify if the job must apply the modifications or not.
- type: boolean
- default: false
- result:
- description: The result of the batch job.
- nullable: true
- allOf:
- - type: object
- example: {}
- - type: object
- properties:
- count:
- type: number
- advancement_count:
- type: number
- progress:
- type: number
- errors:
- type: object
- properties:
- message:
- type: string
- code:
- oneOf:
- - type: string
- - type: number
- err:
- type: array
- stat_descriptors:
- type: object
- properties:
- key:
- type: string
- name:
- type: string
- message:
- type: string
- file_key:
- type: string
- file_size:
- type: number
- example:
- errors:
- - err: []
- code: unknown
- message: Method not implemented.
- stat_descriptors:
- - key: product-export-count
- name: Product count to export
- message: There will be 8 products exported by this action
- pre_processed_at:
- description: The date from which the job has been pre-processed.
- nullable: true
- type: string
- format: date-time
- processing_at:
- description: The date the job is processing at.
- nullable: true
- type: string
- format: date-time
- confirmed_at:
- description: The date when the confirmation has been done.
- nullable: true
- type: string
- format: date-time
- completed_at:
- description: The date of the completion.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date of the concellation.
- nullable: true
- type: string
- format: date-time
- failed_at:
- description: The date when the job failed.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was last updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/Campaign.yaml b/www/apps/api-reference/specs/store/components/schemas/Campaign.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/Campaign.yaml
rename to www/apps/api-reference/specs/store/components/schemas/Campaign.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CampaignBudget.yaml b/www/apps/api-reference/specs/store/components/schemas/CampaignBudget.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CampaignBudget.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CampaignBudget.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/Cart.yaml b/www/apps/api-reference/specs/store/components/schemas/Cart.yaml
deleted file mode 100644
index 4283873041..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Cart.yaml
+++ /dev/null
@@ -1,243 +0,0 @@
-title: Cart
-description: >-
- A cart represents a virtual shopping bag. It can be used to complete an order,
- a swap, or a claim.
-type: object
-required:
- - billing_address_id
- - completed_at
- - context
- - created_at
- - customer_id
- - deleted_at
- - email
- - id
- - idempotency_key
- - metadata
- - payment_authorized_at
- - payment_id
- - payment_session
- - region_id
- - shipping_address_id
- - type
- - updated_at
-properties:
- id:
- description: The cart's ID
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- email:
- description: The email associated with the cart
- nullable: true
- type: string
- format: email
- billing_address_id:
- description: The billing address's ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the cart.
- x-expandable: billing_address
- nullable: true
- $ref: ./Address.yaml
- shipping_address_id:
- description: The shipping address's ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address associated with the cart.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- items:
- description: The line items added to the cart.
- type: array
- x-expandable: items
- items:
- $ref: ./LineItem.yaml
- region_id:
- description: The region's ID
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region associated with the cart.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- discounts:
- description: An array of details of all discounts applied to the cart.
- type: array
- x-expandable: discounts
- items:
- $ref: ./Discount.yaml
- gift_cards:
- description: An array of details of all gift cards applied to the cart.
- type: array
- x-expandable: gift_cards
- items:
- $ref: ./GiftCard.yaml
- customer_id:
- description: The customer's ID
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer the cart belongs to.
- x-expandable: customer
- nullable: true
- type: object
- payment_session:
- description: The details of the selected payment session in the cart.
- x-expandable: payment_session
- nullable: true
- type: object
- payment_sessions:
- description: The details of all payment sessions created on the cart.
- type: array
- x-expandable: payment_sessions
- items:
- type: object
- payment_id:
- description: The payment's ID if available
- nullable: true
- type: string
- example: pay_01G8ZCC5W42ZNY842124G7P5R9
- payment:
- description: The details of the payment associated with the cart.
- nullable: true
- x-expandable: payment
- type: object
- shipping_methods:
- description: The details of the shipping methods added to the cart.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- type:
- description: The cart's type.
- type: string
- enum:
- - default
- - swap
- - draft_order
- - payment_link
- - claim
- default: default
- completed_at:
- description: The date with timezone at which the cart was completed.
- nullable: true
- type: string
- format: date-time
- payment_authorized_at:
- description: The date with timezone at which the payment was authorized.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a cart in case
- of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- context:
- description: The context of the cart which can include info like IP or user agent.
- nullable: true
- type: object
- example:
- ip: '::1'
- user_agent: PostmanRuntime/7.29.2
- sales_channel_id:
- description: The sales channel ID the cart is associated with.
- nullable: true
- type: string
- example: null
- sales_channel:
- description: The details of the sales channel associated with the cart.
- nullable: true
- x-expandable: sales_channel
- $ref: ./SalesChannel.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- shipping_total:
- description: The total of shipping
- type: integer
- example: 1000
- discount_total:
- description: The total of discount rounded
- type: integer
- example: 800
- raw_discount_total:
- description: The total of discount
- type: integer
- example: 800
- item_tax_total:
- description: The total of items with taxes
- type: integer
- example: 8000
- shipping_tax_total:
- description: The total of shipping with taxes
- type: integer
- example: 1000
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- refunded_total:
- description: >-
- The total amount refunded if the order associated with this cart is
- returned.
- type: integer
- example: 0
- total:
- description: The total amount of the cart
- type: integer
- example: 8200
- subtotal:
- description: The subtotal of the cart
- type: integer
- example: 8000
- refundable_amount:
- description: The amount that can be refunded
- type: integer
- example: 8200
- gift_card_total:
- description: The total of gift cards
- type: integer
- example: 0
- gift_card_tax_total:
- description: The total of gift cards with taxes
- type: integer
- example: 0
- sales_channels:
- description: The associated sales channels.
- type: array
- nullable: true
- x-expandable: sales_channels
- items:
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/ClaimImage.yaml b/www/apps/api-reference/specs/store/components/schemas/ClaimImage.yaml
deleted file mode 100644
index 7b64e6be1d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ClaimImage.yaml
+++ /dev/null
@@ -1,51 +0,0 @@
-title: Claim Image
-description: The details of an image attached to a claim.
-type: object
-required:
- - claim_item_id
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - url
-properties:
- id:
- description: The claim image's ID
- type: string
- example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
- claim_item_id:
- description: The ID of the claim item associated with the image
- type: string
- claim_item:
- description: The details of the claim item this image is associated with.
- nullable: true
- x-expandable: claim_item
- type: object
- url:
- description: The URL of the image
- type: string
- format: uri
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ClaimItem.yaml b/www/apps/api-reference/specs/store/components/schemas/ClaimItem.yaml
deleted file mode 100644
index 6d9a8a9b67..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ClaimItem.yaml
+++ /dev/null
@@ -1,106 +0,0 @@
-title: Claim Item
-description: >-
- A claim item is an item created as part of a claim. It references an item in
- the order that should be exchanged or refunded.
-type: object
-required:
- - claim_order_id
- - created_at
- - deleted_at
- - id
- - item_id
- - metadata
- - note
- - quantity
- - reason
- - updated_at
- - variant_id
-properties:
- id:
- description: The claim item's ID
- type: string
- example: citm_01G8ZH853Y6TFXWPG5EYE81X63
- images:
- description: The claim images that are attached to the claim item.
- type: array
- x-expandable: images
- items:
- $ref: ./ClaimImage.yaml
- claim_order_id:
- description: The ID of the claim this item is associated with.
- type: string
- claim_order:
- description: The details of the claim this item belongs to.
- x-expandable: claim_order
- nullable: true
- type: object
- item_id:
- description: The ID of the line item that the claim item refers to.
- type: string
- example: item_01G8ZM25TN49YV9EQBE2NC27KC
- item:
- description: >-
- The details of the line item in the original order that this claim item
- refers to.
- x-expandable: item
- nullable: true
- $ref: ./LineItem.yaml
- variant_id:
- description: The ID of the product variant that is claimed.
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: >-
- The details of the product variant to potentially replace the item in the
- original order.
- x-expandable: variant
- nullable: true
- $ref: ./ProductVariant.yaml
- reason:
- description: The reason for the claim
- type: string
- enum:
- - missing_item
- - wrong_item
- - production_failure
- - other
- note:
- description: An optional note about the claim, for additional information
- nullable: true
- type: string
- example: I don't like it.
- quantity:
- description: >-
- The quantity of the item that is being claimed; must be less than or equal
- to the amount purchased in the original order.
- type: integer
- example: 1
- tags:
- description: User defined tags for easy filtering and grouping.
- type: array
- x-expandable: tags
- items:
- $ref: ./ClaimTag.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ClaimOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/ClaimOrder.yaml
deleted file mode 100644
index e3de8e9d1b..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ClaimOrder.yaml
+++ /dev/null
@@ -1,157 +0,0 @@
-title: Claim
-description: >-
- A Claim represents a group of faulty or missing items. It consists of claim
- items that refer to items in the original order that should be replaced or
- refunded. It also includes details related to shipping and fulfillment.
-type: object
-required:
- - canceled_at
- - created_at
- - deleted_at
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - order_id
- - payment_status
- - refund_amount
- - shipping_address_id
- - type
- - updated_at
-properties:
- id:
- description: The claim's ID
- type: string
- example: claim_01G8ZH853Y6TFXWPG5EYE81X63
- type:
- description: The claim's type
- type: string
- enum:
- - refund
- - replace
- payment_status:
- description: The status of the claim's payment
- type: string
- enum:
- - na
- - not_refunded
- - refunded
- default: na
- fulfillment_status:
- description: The claim's fulfillment status
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- default: not_fulfilled
- claim_items:
- description: The details of the items that should be replaced or refunded.
- type: array
- x-expandable: claim_items
- items:
- $ref: ./ClaimItem.yaml
- additional_items:
- description: >-
- The details of the new items to be shipped when the claim's type is
- `replace`
- type: array
- x-expandable: additional_items
- items:
- $ref: ./LineItem.yaml
- order_id:
- description: The ID of the order that the claim comes from.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that this claim was created for.
- x-expandable: order
- nullable: true
- type: object
- return_order:
- description: >-
- The details of the return associated with the claim if the claim's type is
- `replace`.
- x-expandable: return_order
- nullable: true
- type: object
- shipping_address_id:
- description: The ID of the address that the new items should be shipped to
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the address that new items should be shipped to.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- shipping_methods:
- description: >-
- The details of the shipping methods that the claim order will be shipped
- with.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- fulfillments:
- description: The fulfillments of the new items to be shipped
- type: array
- x-expandable: fulfillments
- items:
- type: object
- refund_amount:
- description: The amount that will be refunded in conjunction with the claim
- nullable: true
- type: integer
- example: 1000
- canceled_at:
- description: The date with timezone at which the claim was canceled.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- no_notification:
- description: >-
- Flag for describing whether or not notifications related to this should be
- send.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the cart
- associated with the claim in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
diff --git a/www/apps/api-reference/specs/store/components/schemas/ClaimTag.yaml b/www/apps/api-reference/specs/store/components/schemas/ClaimTag.yaml
deleted file mode 100644
index 4c8924448f..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ClaimTag.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Claim Tag
-description: >-
- Claim Tags are user defined tags that can be assigned to claim items for easy
- filtering and grouping.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
-properties:
- id:
- description: The claim tag's ID
- type: string
- example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4
- value:
- description: The value that the claim tag holds
- type: string
- example: Damaged
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/Country.yaml b/www/apps/api-reference/specs/store/components/schemas/Country.yaml
deleted file mode 100644
index cfa712f0ff..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Country.yaml
+++ /dev/null
@@ -1,58 +0,0 @@
-title: Country
-description: Country details
-type: object
-required:
- - display_name
- - id
- - iso_2
- - iso_3
- - name
- - num_code
- - region_id
-properties:
- id:
- description: The country's ID
- type: string
- example: 109
- iso_2:
- description: The 2 character ISO code of the country in lower case
- type: string
- example: it
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- iso_3:
- description: The 2 character ISO code of the country in lower case
- type: string
- example: ita
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements
- description: See a list of codes.
- num_code:
- description: The numerical ISO code for the country.
- type: string
- example: 380
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements
- description: See a list of codes.
- name:
- description: The normalized country name in upper case.
- type: string
- example: ITALY
- display_name:
- description: The country name appropriate for display.
- type: string
- example: Italy
- region_id:
- description: The region ID this country is associated with.
- nullable: true
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region the country is associated with.
- x-expandable: region
- nullable: true
- type: object
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateAddress.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateApiKey.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateApiKey.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateApiKey.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateApplicationMethod.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateApplicationMethod.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateApplicationMethod.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCampaign.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCampaign.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCampaign.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCampaign.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCampaignBudget.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCampaignBudget.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCampaignBudget.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCampaignBudget.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCartAddress.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCartCreateLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCartCreateLineItem.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCartWorkflowInput.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCartWorkflowInput.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCustomer.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCustomer.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCustomer.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCustomerAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCustomerAddress.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCustomerAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCustomerGroup.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateCustomerGroup.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateCustomerGroup.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateDefaultTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateDefaultTaxRate.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateDefaultTaxRate.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateDefaultTaxRate.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateInvite.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateInvite.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateInvite.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateInvite.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProduct.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProduct.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProduct.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProductCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductCollection.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProductCollection.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProductCollection.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductOption.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProductOption.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProductOption.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductTag.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProductTag.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProductTag.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductType.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProductType.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProductType.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductVariant.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProductVariant.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProductVariant.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateProductVariantOption.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateProductVariantOption.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateProductVariantOption.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateProductVariantOption.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreatePromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/CreatePromotion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreatePromotion.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreatePromotion.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreatePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/CreatePromotionRule.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreatePromotionRule.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreatePromotionRule.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateRegion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateRegion.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateRegion.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateStockLocationInput.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateStockLocationInput.yaml
deleted file mode 100644
index 6a8d7255f5..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/CreateStockLocationInput.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-title: Create Stock Location Input
-description: Represents the Input to create a Stock Location
-type: object
-required:
- - name
-properties:
- name:
- type: string
- description: The stock location name
- address_id:
- type: string
- description: The Stock location address ID
- address:
- description: Stock location address object
- allOf:
- - $ref: ./StockLocationAddressInput.yaml
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateTaxRateRule.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateTaxRateRule.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateTaxRateRule.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateTaxRateRule.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CreateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CreateUser.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CreateUser.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/Currency.yaml b/www/apps/api-reference/specs/store/components/schemas/Currency.yaml
deleted file mode 100644
index adfb21705c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Currency.yaml
+++ /dev/null
@@ -1,33 +0,0 @@
-title: Currency
-description: Currency
-type: object
-required:
- - code
- - name
- - symbol
- - symbol_native
-properties:
- code:
- description: The 3 character ISO code for the currency.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- symbol:
- description: The symbol used to indicate the currency.
- type: string
- example: $
- symbol_native:
- description: The native symbol used to indicate the currency.
- type: string
- example: $
- name:
- description: The written name of the currency
- type: string
- example: US Dollar
- includes_tax:
- description: Whether the currency prices include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomShippingOption.yaml
deleted file mode 100644
index 472d04273b..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/CustomShippingOption.yaml
+++ /dev/null
@@ -1,68 +0,0 @@
-title: Custom Shipping Option
-description: >-
- Custom Shipping Options are overridden Shipping Options. Admins can attach a
- Custom Shipping Option to a cart in order to set a custom price for a
- particular Shipping Option.
-type: object
-required:
- - cart_id
- - created_at
- - deleted_at
- - id
- - metadata
- - price
- - shipping_option_id
- - updated_at
-properties:
- id:
- description: The custom shipping option's ID
- type: string
- example: cso_01G8X99XNB77DMFBJFWX6DN9V9
- price:
- description: >-
- The custom price set that will override the shipping option's original
- price
- type: integer
- example: 1000
- shipping_option_id:
- description: The ID of the Shipping Option that the custom shipping option overrides
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the overridden shipping options.
- x-expandable: shipping_option
- nullable: true
- $ref: ./ShippingOption.yaml
- cart_id:
- description: The ID of the Cart that the custom shipping option is attached to
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart this shipping option belongs to.
- x-expandable: cart
- nullable: true
- $ref: ./Cart.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/Customer.yaml b/www/apps/api-reference/specs/store/components/schemas/Customer.yaml
index ecc9c83ee4..063a4ff87a 100644
--- a/www/apps/api-reference/specs/store/components/schemas/Customer.yaml
+++ b/www/apps/api-reference/specs/store/components/schemas/Customer.yaml
@@ -1,94 +1,87 @@
-title: Customer
-description: A customer can make purchases in your store and manage their profile.
type: object
-required:
- - billing_address_id
- - created_at
- - deleted_at
- - email
- - first_name
- - has_account
- - id
- - last_name
- - metadata
- - phone
- - updated_at
+description: The context's customer.
+x-schemaName: Customer
properties:
id:
- description: The customer's ID
type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
+ title: id
+ description: The customer's ID.
email:
- description: The customer's email
type: string
+ title: email
+ description: The customer's email.
format: email
+ default_billing_address_id:
+ type: string
+ title: default_billing_address_id
+ description: The customer's default billing address id.
+ default_shipping_address_id:
+ type: string
+ title: default_shipping_address_id
+ description: The customer's default shipping address id.
+ company_name:
+ type: string
+ title: company_name
+ description: The customer's company name.
first_name:
- description: The customer's first name
- nullable: true
type: string
- example: Arno
+ title: first_name
+ description: The customer's first name.
last_name:
- description: The customer's last name
- nullable: true
type: string
- example: Willms
- billing_address_id:
- description: The customer's billing address ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the customer.
- x-expandable: billing_address
- nullable: true
- $ref: ./Address.yaml
- shipping_addresses:
- description: The details of the shipping addresses associated with the customer.
+ title: last_name
+ description: The customer's last name.
+ addresses:
type: array
- x-expandable: shipping_addresses
- items:
- $ref: ./Address.yaml
- phone:
- description: The customer's phone number
- nullable: true
- type: string
- example: 16128234334802
- has_account:
- description: Whether the customer has an account or not
- type: boolean
- default: false
- orders:
- description: The details of the orders this customer placed.
- type: array
- x-expandable: orders
+ description: The customer's addresses.
items:
type: object
+ description: The address's addresses.
+ x-schemaName: CustomerAddress
+ properties: {}
+ phone:
+ type: string
+ title: phone
+ description: The customer's phone.
groups:
- description: The customer groups the customer belongs to.
type: array
- x-expandable: groups
+ description: The customer's groups.
items:
- $ref: ./CustomerGroup.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
+ type: object
+ description: The group's groups.
+ properties: {}
metadata:
- description: An optional key-value map with additional details
- nullable: true
type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
+ description: The customer's metadata.
+ properties: {}
+ created_by:
+ type: string
+ title: created_by
+ description: The customer's created by.
+ deleted_at:
+ oneOf:
+ - type: string
+ title: deleted_at
+ description: The customer's deleted at.
+ - type: string
+ title: deleted_at
+ description: The customer's deleted at.
+ format: date-time
+ created_at:
+ oneOf:
+ - type: string
+ title: created_at
+ description: The customer's created at.
+ - type: string
+ title: created_at
+ description: The customer's created at.
+ format: date-time
+ updated_at:
+ oneOf:
+ - type: string
+ title: updated_at
+ description: The customer's updated at.
+ - type: string
+ title: updated_at
+ description: The customer's updated at.
+ format: date-time
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CustomerAddress.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CustomerAddress.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/CustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerGroup.yaml
deleted file mode 100644
index a572493cad..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/CustomerGroup.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-title: Customer Group
-description: >-
- A customer group that can be used to organize customers into groups of similar
- traits.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - name
- - updated_at
-properties:
- id:
- description: The customer group's ID
- type: string
- example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
- name:
- description: The name of the customer group
- type: string
- example: VIP
- customers:
- description: The details of the customers that belong to the customer group.
- type: array
- x-expandable: customers
- items:
- type: object
- price_lists:
- description: The price lists that are associated with the customer group.
- type: array
- x-expandable: price_lists
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CustomerGroupUpdatableFields.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupUpdatableFields.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CustomerGroupUpdatableFields.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CustomerGroupUpdatableFields.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CustomerGroupsBatchCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupsBatchCustomer.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CustomerGroupsBatchCustomer.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CustomerGroupsBatchCustomer.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/CustomerUpdatableFields.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerUpdatableFields.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/CustomerUpdatableFields.yaml
rename to www/apps/api-reference/specs/store/components/schemas/CustomerUpdatableFields.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/Discount.yaml b/www/apps/api-reference/specs/store/components/schemas/Discount.yaml
deleted file mode 100644
index 796477999f..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Discount.yaml
+++ /dev/null
@@ -1,121 +0,0 @@
-title: Discount
-description: A discount can be applied to a cart for promotional purposes.
-type: object
-required:
- - code
- - created_at
- - deleted_at
- - ends_at
- - id
- - is_disabled
- - is_dynamic
- - metadata
- - parent_discount_id
- - rule_id
- - starts_at
- - updated_at
- - usage_count
- - usage_limit
- - valid_duration
-properties:
- id:
- description: The discount's ID
- type: string
- example: disc_01F0YESMW10MGHWJKZSDDMN0VN
- code:
- description: >-
- A unique code for the discount - this will be used by the customer to
- apply the discount
- type: string
- example: 10DISC
- is_dynamic:
- description: >-
- A flag to indicate if multiple instances of the discount can be generated.
- I.e. for newsletter discounts
- type: boolean
- example: false
- rule_id:
- description: >-
- The ID of the discount rule that defines how the discount will be applied
- to a cart.
- nullable: true
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- rule:
- description: >-
- The details of the discount rule that defines how the discount will be
- applied to a cart..
- x-expandable: rule
- nullable: true
- $ref: ./DiscountRule.yaml
- is_disabled:
- description: >-
- Whether the Discount has been disabled. Disabled discounts cannot be
- applied to carts
- type: boolean
- example: false
- parent_discount_id:
- description: >-
- The Discount that the discount was created from. This will always be a
- dynamic discount
- nullable: true
- type: string
- example: disc_01G8ZH853YPY9B94857DY91YGW
- parent_discount:
- description: The details of the parent discount that this discount was created from.
- x-expandable: parent_discount
- nullable: true
- type: object
- starts_at:
- description: The time at which the discount can be used.
- type: string
- format: date-time
- ends_at:
- description: The time at which the discount can no longer be used.
- nullable: true
- type: string
- format: date-time
- valid_duration:
- description: Duration the discount runs between
- nullable: true
- type: string
- example: P3Y6M4DT12H30M5S
- regions:
- description: The details of the regions in which the Discount can be used.
- type: array
- x-expandable: regions
- items:
- $ref: ./Region.yaml
- usage_limit:
- description: The maximum number of times that a discount can be used.
- nullable: true
- type: integer
- example: 100
- usage_count:
- description: The number of times a discount has been used.
- type: integer
- example: 50
- default: 0
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountCondition.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountCondition.yaml
deleted file mode 100644
index 4652b43d56..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountCondition.yaml
+++ /dev/null
@@ -1,105 +0,0 @@
-title: Discount Condition
-description: Holds rule conditions for when a discount is applicable
-type: object
-required:
- - created_at
- - deleted_at
- - discount_rule_id
- - id
- - metadata
- - operator
- - type
- - updated_at
-properties:
- id:
- description: The discount condition's ID
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- type:
- description: >-
- The type of the condition. The type affects the available resources
- associated with the condition. For example, if the type is `products`,
- that means the `products` relation will hold the products associated with
- this condition and other relations will be empty.
- type: string
- enum:
- - products
- - product_types
- - product_collections
- - product_tags
- - customer_groups
- operator:
- description: >-
- The operator of the condition. `in` indicates that discountable resources
- are within the specified resources. `not_in` indicates that discountable
- resources are everything but the specified resources.
- type: string
- enum:
- - in
- - not_in
- discount_rule_id:
- description: The ID of the discount rule associated with the condition
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- discount_rule:
- description: The details of the discount rule associated with the condition.
- x-expandable: discount_rule
- nullable: true
- $ref: ./DiscountRule.yaml
- products:
- description: products associated with this condition if `type` is `products`.
- type: array
- x-expandable: products
- items:
- $ref: ./Product.yaml
- product_types:
- description: Product types associated with this condition if `type` is `product_types`.
- type: array
- x-expandable: product_types
- items:
- $ref: ./ProductType.yaml
- product_tags:
- description: Product tags associated with this condition if `type` is `product_tags`.
- type: array
- x-expandable: product_tags
- items:
- $ref: ./ProductTag.yaml
- product_collections:
- description: >-
- Product collections associated with this condition if `type` is
- `product_collections`.
- type: array
- x-expandable: product_collections
- items:
- $ref: ./ProductCollection.yaml
- customer_groups:
- description: >-
- Customer groups associated with this condition if `type` is
- `customer_groups`.
- type: array
- x-expandable: customer_groups
- items:
- $ref: ./CustomerGroup.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountConditionCustomerGroup.yaml
deleted file mode 100644
index 2f55e79142..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionCustomerGroup.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Product Tag Discount Condition
-description: Associates a discount condition with a customer group
-type: object
-required:
- - condition_id
- - created_at
- - customer_group_id
- - metadata
- - updated_at
-properties:
- customer_group_id:
- description: The ID of the Product Tag
- type: string
- example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- customer_group:
- description: Available if the relation `customer_group` is expanded.
- nullable: true
- $ref: ./CustomerGroup.yaml
- discount_condition:
- description: Available if the relation `discount_condition` is expanded.
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProduct.yaml
deleted file mode 100644
index 2fb9699b9e..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProduct.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Product Discount Condition
-description: This represents the association between a discount condition and a product
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_id
- - updated_at
-properties:
- product_id:
- description: The ID of the Product Tag
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product:
- description: The details of the product.
- x-expandable: product
- nullable: true
- $ref: ./Product.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductCollection.yaml
deleted file mode 100644
index 5e8b88b9e3..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductCollection.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Collection Discount Condition
-description: >-
- This represents the association between a discount condition and a product
- collection
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_collection_id
- - updated_at
-properties:
- product_collection_id:
- description: The ID of the Product Collection
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_collection:
- description: The details of the product collection.
- x-expandable: product_collection
- nullable: true
- $ref: ./ProductCollection.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductTag.yaml
deleted file mode 100644
index 58ba07c6c3..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductTag.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Product Tag Discount Condition
-description: This represents the association between a discount condition and a product tag
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_tag_id
- - updated_at
-properties:
- product_tag_id:
- description: The ID of the Product Tag
- type: string
- example: ptag_01F0YESHPZYY3H4SJ3A5918SBN
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_tag:
- description: The details of the product tag.
- x-expandable: product_tag
- nullable: true
- $ref: ./ProductTag.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductType.yaml
deleted file mode 100644
index d93129494c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountConditionProductType.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Type Discount Condition
-description: >-
- This represents the association between a discount condition and a product
- type
-type: object
-required:
- - condition_id
- - created_at
- - metadata
- - product_type_id
- - updated_at
-properties:
- product_type_id:
- description: The ID of the Product Tag
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_type:
- description: The details of the product type.
- x-expandable: product_type
- nullable: true
- $ref: ./ProductType.yaml
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: ./DiscountCondition.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DiscountRule.yaml b/www/apps/api-reference/specs/store/components/schemas/DiscountRule.yaml
deleted file mode 100644
index caa7f9d604..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DiscountRule.yaml
+++ /dev/null
@@ -1,79 +0,0 @@
-title: Discount Rule
-description: A discount rule defines how a Discount is calculated when applied to a Cart.
-type: object
-required:
- - allocation
- - created_at
- - deleted_at
- - description
- - id
- - metadata
- - type
- - updated_at
- - value
-properties:
- id:
- description: The discount rule's ID
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- type:
- description: >-
- The type of the Discount, can be `fixed` for discounts that reduce the
- price by a fixed amount, `percentage` for percentage reductions or
- `free_shipping` for shipping vouchers.
- type: string
- enum:
- - fixed
- - percentage
- - free_shipping
- example: percentage
- description:
- description: A short description of the discount
- nullable: true
- type: string
- example: 10 Percent
- value:
- description: >-
- The value that the discount represents; this will depend on the type of
- the discount
- type: integer
- example: 10
- allocation:
- description: The scope that the discount should apply to.
- nullable: true
- type: string
- enum:
- - total
- - item
- example: total
- conditions:
- description: >-
- The details of the discount conditions associated with the rule. They can
- be used to limit when the discount can be used.
- type: array
- x-expandable: conditions
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/DraftOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/DraftOrder.yaml
deleted file mode 100644
index 86ff90bf25..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/DraftOrder.yaml
+++ /dev/null
@@ -1,103 +0,0 @@
-title: DraftOrder
-description: >-
- A draft order is created by an admin without direct involvement of the
- customer. Once its payment is marked as captured, it is transformed into an
- order.
-type: object
-required:
- - canceled_at
- - cart_id
- - completed_at
- - created_at
- - display_id
- - id
- - idempotency_key
- - metadata
- - no_notification_order
- - order_id
- - status
- - updated_at
-properties:
- id:
- description: The draft order's ID
- type: string
- example: dorder_01G8TJFKBG38YYFQ035MSVG03C
- status:
- description: >-
- The status of the draft order. It's changed to `completed` when it's
- transformed to an order.
- type: string
- enum:
- - open
- - completed
- default: open
- display_id:
- description: The draft order's display ID
- type: string
- example: 2
- cart_id:
- description: The ID of the cart associated with the draft order.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart associated with the draft order.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: >-
- The ID of the order created from the draft order when its payment is
- captured.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: >-
- The details of the order created from the draft order when its payment is
- captured.
- x-expandable: order
- nullable: true
- type: object
- canceled_at:
- description: The date the draft order was canceled at.
- nullable: true
- type: string
- format: date-time
- completed_at:
- description: The date the draft order was completed at.
- nullable: true
- type: string
- format: date-time
- no_notification_order:
- description: Whether to send the customer notifications regarding order updates.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the cart
- associated with the draft order in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml
deleted file mode 100644
index fe169bafc5..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ExtendedStoreDTO.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-allOf:
- - $ref: ./Store.yaml
- - type: object
- required:
- - payment_providers
- - fulfillment_providers
- - feature_flags
- - modules
- properties:
- payment_providers:
- description: The store's payment providers.
- $ref: ./PaymentProvider.yaml
- fulfillment_providers:
- description: The store's fulfillment providers.
- $ref: ./FulfillmentProvider.yaml
- feature_flags:
- description: The feature flags enabled in the store's backend.
- $ref: ./FeatureFlagsResponse.yaml
- modules:
- description: The modules installed in the store's backend.
- $ref: ./ModulesResponse.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/FeatureFlagsResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/FeatureFlagsResponse.yaml
deleted file mode 100644
index ce55d9ccc4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/FeatureFlagsResponse.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: array
-items:
- type: object
- required:
- - key
- - value
- properties:
- key:
- description: The key of the feature flag.
- type: string
- value:
- description: The value of the feature flag.
- type: boolean
diff --git a/www/apps/api-reference/specs/store/components/schemas/Fulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/Fulfillment.yaml
deleted file mode 100644
index b9f77587a4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Fulfillment.yaml
+++ /dev/null
@@ -1,151 +0,0 @@
-title: Fulfillment
-description: >-
- A Fulfillment is created once an admin can prepare the purchased goods.
- Fulfillments will eventually be shipped and hold information about how to
- track shipments. Fulfillments are created through a fulfillment provider,
- which typically integrates a third-party shipping service. Fulfillments can be
- associated with orders, claims, swaps, and returns.
-type: object
-required:
- - canceled_at
- - claim_order_id
- - created_at
- - data
- - id
- - idempotency_key
- - location_id
- - metadata
- - no_notification
- - order_id
- - provider_id
- - shipped_at
- - swap_id
- - tracking_numbers
- - updated_at
-properties:
- id:
- description: The fulfillment's ID
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- claim_order_id:
- description: The ID of the Claim that the Fulfillment belongs to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the fulfillment may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- swap_id:
- description: The ID of the Swap that the Fulfillment belongs to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the fulfillment may belong to.
- x-expandable: swap
- nullable: true
- type: object
- order_id:
- description: The ID of the Order that the Fulfillment belongs to.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the fulfillment may belong to.
- x-expandable: order
- nullable: true
- type: object
- provider_id:
- description: >-
- The ID of the Fulfillment Provider responsible for handling the
- fulfillment.
- type: string
- example: manual
- provider:
- description: >-
- The details of the fulfillment provider responsible for handling the
- fulfillment.
- x-expandable: provider
- nullable: true
- $ref: ./FulfillmentProvider.yaml
- location_id:
- description: The ID of the stock location the fulfillment will be shipped from
- nullable: true
- type: string
- example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
- items:
- description: >-
- The Fulfillment Items in the Fulfillment. These hold information about how
- many of each Line Item has been fulfilled.
- type: array
- x-expandable: items
- items:
- $ref: ./FulfillmentItem.yaml
- tracking_links:
- description: >-
- The Tracking Links that can be used to track the status of the
- Fulfillment. These will usually be provided by the Fulfillment Provider.
- type: array
- x-expandable: tracking_links
- items:
- $ref: ./TrackingLink.yaml
- tracking_numbers:
- description: >-
- The tracking numbers that can be used to track the status of the
- fulfillment.
- deprecated: true
- type: array
- items:
- type: string
- data:
- description: >-
- This contains all the data necessary for the Fulfillment provider to
- handle the fulfillment.
- type: object
- example: {}
- shipped_at:
- description: The date with timezone at which the Fulfillment was shipped.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: >-
- Flag for describing whether or not notifications related to this should be
- sent.
- nullable: true
- type: boolean
- example: false
- canceled_at:
- description: The date with timezone at which the Fulfillment was canceled.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the fulfillment
- in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/FulfillmentItem.yaml b/www/apps/api-reference/specs/store/components/schemas/FulfillmentItem.yaml
deleted file mode 100644
index 7204760274..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/FulfillmentItem.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
-title: Fulfillment Item
-description: This represents the association between a Line Item and a Fulfillment.
-type: object
-required:
- - fulfillment_id
- - item_id
- - quantity
-properties:
- fulfillment_id:
- description: The ID of the Fulfillment that the Fulfillment Item belongs to.
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- item_id:
- description: The ID of the Line Item that the Fulfillment Item references.
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- fulfillment:
- description: The details of the fulfillment.
- x-expandable: fulfillment
- nullable: true
- type: object
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- $ref: ./LineItem.yaml
- quantity:
- description: The quantity of the Line Item that is included in the Fulfillment.
- type: integer
- example: 1
diff --git a/www/apps/api-reference/specs/store/components/schemas/FulfillmentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/FulfillmentProvider.yaml
deleted file mode 100644
index 366e045f2f..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/FulfillmentProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Fulfillment Provider
-description: >-
- A fulfillment provider represents a fulfillment service installed in the
- Medusa backend, either through a plugin or backend customizations. It holds
- the fulfillment service's installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the fulfillment provider as given by the fulfillment service.
- type: string
- example: manual
- is_installed:
- description: >-
- Whether the fulfillment service is installed in the current version. If a
- fulfillment service is no longer installed, the `is_installed` attribute
- is set to `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/store/components/schemas/GiftCard.yaml b/www/apps/api-reference/specs/store/components/schemas/GiftCard.yaml
deleted file mode 100644
index cd3b03dc19..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/GiftCard.yaml
+++ /dev/null
@@ -1,96 +0,0 @@
-title: Gift Card
-description: >-
- Gift Cards are redeemable and represent a value that can be used towards the
- payment of an Order.
-type: object
-required:
- - balance
- - code
- - created_at
- - deleted_at
- - ends_at
- - id
- - is_disabled
- - metadata
- - order_id
- - region_id
- - tax_rate
- - updated_at
- - value
-properties:
- id:
- description: The gift card's ID
- type: string
- example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
- code:
- description: >-
- The unique code that identifies the Gift Card. This is used by the
- Customer to redeem the value of the Gift Card.
- type: string
- example: 3RFT-MH2C-Y4YZ-XMN4
- value:
- description: The value that the Gift Card represents.
- type: integer
- example: 10
- balance:
- description: The remaining value on the Gift Card.
- type: integer
- example: 10
- region_id:
- description: The ID of the region this gift card is available in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this gift card is available in.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- order_id:
- description: The ID of the order that the gift card was purchased in.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the gift card was purchased in.
- x-expandable: region
- nullable: true
- type: object
- is_disabled:
- description: >-
- Whether the Gift Card has been disabled. Disabled Gift Cards cannot be
- applied to carts.
- type: boolean
- default: false
- ends_at:
- description: The time at which the Gift Card can no longer be used.
- nullable: true
- type: string
- format: date-time
- tax_rate:
- description: The gift card's tax rate that will be applied on calculating totals
- nullable: true
- type: number
- example: 0
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/GiftCardTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/GiftCardTransaction.yaml
deleted file mode 100644
index e1f3f9b490..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/GiftCardTransaction.yaml
+++ /dev/null
@@ -1,54 +0,0 @@
-title: Gift Card Transaction
-description: >-
- Gift Card Transactions are created once a Customer uses a Gift Card to pay for
- their Order.
-type: object
-required:
- - amount
- - created_at
- - gift_card_id
- - id
- - is_taxable
- - order_id
- - tax_rate
-properties:
- id:
- description: The gift card transaction's ID
- type: string
- example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A
- gift_card_id:
- description: The ID of the Gift Card that was used in the transaction.
- type: string
- example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
- gift_card:
- description: The details of the gift card associated used in this transaction.
- x-expandable: gift_card
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the gift card was used for payment.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the gift card was used for payment.
- x-expandable: order
- nullable: true
- type: object
- amount:
- description: The amount that was used from the Gift Card.
- type: integer
- example: 10
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- is_taxable:
- description: Whether the transaction is taxable or not.
- nullable: true
- type: boolean
- example: false
- tax_rate:
- description: The tax rate of the transaction
- nullable: true
- type: number
- example: 0
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/IdObject.yaml b/www/apps/api-reference/specs/store/components/schemas/IdObject.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/IdObject.yaml
rename to www/apps/api-reference/specs/store/components/schemas/IdObject.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/IdempotencyKey.yaml b/www/apps/api-reference/specs/store/components/schemas/IdempotencyKey.yaml
deleted file mode 100644
index 9a8760eec9..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/IdempotencyKey.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-title: Idempotency Key
-description: >-
- Idempotency Key is used to continue a process in case of any failure that
- might occur.
-type: object
-required:
- - created_at
- - id
- - idempotency_key
- - locked_at
- - recovery_point
- - response_code
- - response_body
- - request_method
- - request_params
- - request_path
-properties:
- id:
- description: The idempotency key's ID
- type: string
- example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
- idempotency_key:
- description: >-
- The unique randomly generated key used to determine the state of a
- process.
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: Date which the idempotency key was locked.
- type: string
- format: date-time
- locked_at:
- description: Date which the idempotency key was locked.
- nullable: true
- type: string
- format: date-time
- request_method:
- description: The method of the request
- nullable: true
- type: string
- example: POST
- request_params:
- description: The parameters passed to the request
- nullable: true
- type: object
- example:
- id: cart_01G8ZH853Y6TFXWPG5EYE81X63
- request_path:
- description: The request's path
- nullable: true
- type: string
- example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
- response_code:
- description: The response's code.
- nullable: true
- type: string
- example: 200
- response_body:
- description: The response's body
- nullable: true
- type: object
- example:
- id: cart_01G8ZH853Y6TFXWPG5EYE81X63
- recovery_point:
- description: Where to continue from.
- type: string
- default: started
diff --git a/www/apps/api-reference/specs/store/components/schemas/Image.yaml b/www/apps/api-reference/specs/store/components/schemas/Image.yaml
deleted file mode 100644
index c837dd4b5d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Image.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Image
-description: >-
- An Image is used to store details about uploaded images. Images are uploaded
- by the File Service, and the URL is provided by the File Service.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - url
-properties:
- id:
- type: string
- description: The image's ID
- example: img_01G749BFYR6T8JTVW6SGW3K3E6
- url:
- description: The URL at which the image file can be found.
- type: string
- format: uri
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml
deleted file mode 100644
index 641ec3a26f..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/InventoryItemDTO.yaml
+++ /dev/null
@@ -1,82 +0,0 @@
-type: object
-required:
- - sku
-properties:
- id:
- description: The inventory item's ID.
- type: string
- example: iitem_12334
- sku:
- description: The Stock Keeping Unit (SKU) code of the Inventory Item.
- type: string
- hs_code:
- description: >-
- The Harmonized System code of the Inventory Item. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- origin_country:
- description: >-
- The country in which the Inventory Item was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Inventory Item. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
- type: string
- title:
- description: Title of the inventory item
- type: string
- description:
- description: Description of the inventory item
- type: string
- thumbnail:
- description: Thumbnail for the inventory item
- type: string
- material:
- description: >-
- The material and composition that the Inventory Item is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
- type: string
- weight:
- description: >-
- The weight of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- height:
- description: >-
- The height of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- width:
- description: >-
- The width of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- length:
- description: >-
- The length of the Inventory Item. May be used in shipping rate
- calculations.
- type: number
- requires_shipping:
- description: Whether the item requires shipping.
- type: boolean
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/InventoryLevelDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/InventoryLevelDTO.yaml
deleted file mode 100644
index 8540f71c95..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/InventoryLevelDTO.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-type: object
-required:
- - inventory_item_id
- - location_id
- - stocked_quantity
- - reserved_quantity
- - incoming_quantity
-properties:
- location_id:
- description: the item location ID
- type: string
- stocked_quantity:
- description: the total stock quantity of an inventory item at the given location ID
- type: number
- reserved_quantity:
- description: the reserved stock quantity of an inventory item at the given location ID
- type: number
- incoming_quantity:
- description: the incoming stock quantity of an inventory item at the given location ID
- type: number
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/Invite.yaml b/www/apps/api-reference/specs/store/components/schemas/Invite.yaml
deleted file mode 100644
index 4ab1e33195..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Invite.yaml
+++ /dev/null
@@ -1,68 +0,0 @@
-title: Invite
-description: >-
- An invite is created when an admin user invites a new user to join the store's
- team. Once the invite is accepted, it's deleted.
-type: object
-required:
- - accepted
- - created_at
- - deleted_at
- - expires_at
- - id
- - metadata
- - role
- - token
- - updated_at
- - user_email
-properties:
- id:
- type: string
- description: The invite's ID
- example: invite_01G8TKE4XYCTHSCK2GDEP47RE1
- user_email:
- description: The email of the user being invited.
- type: string
- format: email
- role:
- description: The user's role. These roles don't change the privileges of the user.
- nullable: true
- type: string
- enum:
- - admin
- - member
- - developer
- default: member
- accepted:
- description: Whether the invite was accepted or not.
- type: boolean
- default: false
- token:
- description: The token used to accept the invite.
- type: string
- expires_at:
- description: The date the invite expires at.
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/LineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/LineItem.yaml
deleted file mode 100644
index 155bafaedd..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/LineItem.yaml
+++ /dev/null
@@ -1,243 +0,0 @@
-title: Line Item
-description: >-
- Line Items are created when a product is added to a Cart. When Line Items are
- purchased they will get copied to the resulting order, swap, or claim, and can
- eventually be referenced in Fulfillments and Returns. Line items may also be
- used for order edits.
-type: object
-required:
- - allow_discounts
- - cart_id
- - claim_order_id
- - created_at
- - description
- - fulfilled_quantity
- - has_shipping
- - id
- - is_giftcard
- - is_return
- - metadata
- - order_edit_id
- - order_id
- - original_item_id
- - quantity
- - returned_quantity
- - shipped_quantity
- - should_merge
- - swap_id
- - thumbnail
- - title
- - unit_price
- - updated_at
- - variant_id
-properties:
- id:
- description: The line item's ID
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- cart_id:
- description: The ID of the cart that the line item may belongs to.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the line item may belongs to.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the line item may belongs to.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the line item may belongs to.
- x-expandable: order
- nullable: true
- type: object
- swap_id:
- description: The ID of the swap that the line item may belong to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the line item may belong to.
- x-expandable: swap
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the line item may belong to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the line item may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- tax_lines:
- description: The details of the item's tax lines.
- x-expandable: tax_lines
- type: array
- items:
- $ref: ./LineItemTaxLine.yaml
- adjustments:
- description: >-
- The details of the item's adjustments, which are available when a discount
- is applied on the item.
- x-expandable: adjustments
- type: array
- items:
- $ref: ./LineItemAdjustment.yaml
- original_item_id:
- description: >-
- The ID of the original line item. This is useful if the line item belongs
- to a resource that references an order, such as a return or an order edit.
- nullable: true
- type: string
- order_edit_id:
- description: The ID of the order edit that the item may belong to.
- nullable: true
- type: string
- order_edit:
- description: The details of the order edit.
- x-expandable: order_edit
- nullable: true
- type: object
- title:
- description: The title of the Line Item.
- type: string
- example: Medusa Coffee Mug
- description:
- description: A more detailed description of the contents of the Line Item.
- nullable: true
- type: string
- example: One Size
- thumbnail:
- description: A URL string to a small image of the contents of the Line Item.
- nullable: true
- type: string
- format: uri
- example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png
- is_return:
- description: Is the item being returned
- type: boolean
- default: false
- is_giftcard:
- description: Flag to indicate if the Line Item is a Gift Card.
- type: boolean
- default: false
- should_merge:
- description: >-
- Flag to indicate if new Line Items with the same variant should be merged
- or added as an additional Line Item.
- type: boolean
- default: true
- allow_discounts:
- description: >-
- Flag to indicate if the Line Item should be included when doing discount
- calculations.
- type: boolean
- default: true
- has_shipping:
- description: Flag to indicate if the Line Item has fulfillment associated with it.
- nullable: true
- type: boolean
- example: false
- unit_price:
- description: >-
- The price of one unit of the content in the Line Item. This should be in
- the currency defined by the Cart/Order/Swap/Claim that the Line Item
- belongs to.
- type: integer
- example: 8000
- variant_id:
- description: The id of the Product Variant contained in the Line Item.
- nullable: true
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that this item was created from.
- x-expandable: variant
- nullable: true
- $ref: ./ProductVariant.yaml
- quantity:
- description: The quantity of the content in the Line Item.
- type: integer
- example: 1
- fulfilled_quantity:
- description: The quantity of the Line Item that has been fulfilled.
- nullable: true
- type: integer
- example: 0
- returned_quantity:
- description: The quantity of the Line Item that has been returned.
- nullable: true
- type: integer
- example: 0
- shipped_quantity:
- description: The quantity of the Line Item that has been shipped.
- nullable: true
- type: integer
- example: 0
- refundable:
- description: >-
- The amount that can be refunded from the given Line Item. Takes taxes and
- discounts into consideration.
- type: integer
- example: 0
- subtotal:
- description: The subtotal of the line item
- type: integer
- example: 8000
- tax_total:
- description: The total of tax of the line item
- type: integer
- example: 0
- total:
- description: The total amount of the line item
- type: integer
- example: 8000
- original_total:
- description: The original total amount of the line item
- type: integer
- example: 8000
- original_tax_total:
- description: The original tax total amount of the line item
- type: integer
- example: 0
- discount_total:
- description: The total of discount of the line item rounded
- type: integer
- example: 0
- raw_discount_total:
- description: The total of discount of the line item
- type: integer
- example: 0
- gift_card_total:
- description: The total of the gift card of the line item
- type: integer
- example: 0
- includes_tax:
- description: Indicates if the line item unit_price include tax
- x-featureFlag: tax_inclusive_pricing
- type: boolean
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/LineItemAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/LineItemAdjustment.yaml
deleted file mode 100644
index 7d30b61c15..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/LineItemAdjustment.yaml
+++ /dev/null
@@ -1,52 +0,0 @@
-title: Line Item Adjustment
-description: A Line Item Adjustment includes details on discounts applied on a line item.
-type: object
-required:
- - amount
- - description
- - discount_id
- - id
- - item_id
- - metadata
-properties:
- id:
- description: The Line Item Adjustment's ID
- type: string
- example: lia_01G8TKE4XYCTHSCK2GDEP47RE1
- item_id:
- description: The ID of the line item
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- type: object
- description:
- description: The line item's adjustment description
- type: string
- example: Adjusted item's price.
- discount_id:
- description: The ID of the discount associated with the adjustment
- nullable: true
- type: string
- example: disc_01F0YESMW10MGHWJKZSDDMN0VN
- discount:
- description: The details of the discount associated with the adjustment.
- x-expandable: discount
- nullable: true
- $ref: ./Discount.yaml
- amount:
- description: The adjustment amount
- type: number
- example: 1000
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/LineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/LineItemTaxLine.yaml
deleted file mode 100644
index 69832cdd1e..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/LineItemTaxLine.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-title: Line Item Tax Line
-description: A Line Item Tax Line represents the taxes applied on a line item.
-type: object
-required:
- - code
- - created_at
- - id
- - item_id
- - metadata
- - name
- - rate
- - updated_at
-properties:
- id:
- description: The line item tax line's ID
- type: string
- example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- item_id:
- description: The ID of the line item
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ModulesResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/ModulesResponse.yaml
deleted file mode 100644
index f90e78d9f9..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ModulesResponse.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: array
-items:
- type: object
- required:
- - module
- - resolution
- properties:
- module:
- description: The key of the module.
- type: string
- resolution:
- description: The resolution path of the module or false if module is not installed.
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/MoneyAmount.yaml b/www/apps/api-reference/specs/store/components/schemas/MoneyAmount.yaml
deleted file mode 100644
index 920f9a3242..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/MoneyAmount.yaml
+++ /dev/null
@@ -1,101 +0,0 @@
-title: Money Amount
-description: >-
- A Money Amount represent a price amount, for example, a product variant's
- price or a price in a price list. Each Money Amount either has a Currency or
- Region associated with it to indicate the pricing in a given Currency or, for
- fully region-based pricing, the given price in a specific Region. If
- region-based pricing is used, the amount will be in the currency defined for
- the Region.
-type: object
-required:
- - amount
- - created_at
- - currency_code
- - deleted_at
- - id
- - max_quantity
- - min_quantity
- - price_list_id
- - region_id
- - updated_at
- - variant_id
-properties:
- id:
- description: The money amount's ID
- type: string
- example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
- currency_code:
- description: The 3 character currency code that the money amount may belong to.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency that the money amount may belong to.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- amount:
- description: >-
- The amount in the smallest currecny unit (e.g. cents 100 cents to charge
- $1) that the Product Variant will cost.
- type: integer
- example: 100
- min_quantity:
- description: >-
- The minimum quantity that the Money Amount applies to. If this value is
- not set, the Money Amount applies to all quantities.
- nullable: true
- type: integer
- example: 1
- max_quantity:
- description: >-
- The maximum quantity that the Money Amount applies to. If this value is
- not set, the Money Amount applies to all quantities.
- nullable: true
- type: integer
- example: 1
- price_list_id:
- description: The ID of the price list that the money amount may belong to.
- nullable: true
- type: string
- example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
- price_list:
- description: The details of the price list that the money amount may belong to.
- x-expandable: price_list
- nullable: true
- type: object
- variant_id:
- description: The ID of the Product Variant contained in the Line Item.
- nullable: true
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that the money amount may belong to.
- x-expandable: variant
- nullable: true
- type: object
- region_id:
- description: The region's ID
- nullable: true
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region that the money amount may belong to.
- x-expandable: region
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/Note.yaml b/www/apps/api-reference/specs/store/components/schemas/Note.yaml
deleted file mode 100644
index 9a33972604..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Note.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-title: Note
-description: >-
- A Note is an element that can be used in association with different resources
- to allow admin users to describe additional information. For example, they can
- be used to add additional information about orders.
-type: object
-required:
- - author_id
- - created_at
- - deleted_at
- - id
- - metadata
- - resource_id
- - resource_type
- - updated_at
- - value
-properties:
- id:
- description: The note's ID
- type: string
- example: note_01G8TM8ENBMC7R90XRR1G6H26Q
- resource_type:
- description: The type of resource that the Note refers to.
- type: string
- example: order
- resource_id:
- description: The ID of the resource that the Note refers to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- value:
- description: The contents of the note.
- type: string
- example: This order must be fulfilled on Monday
- author_id:
- description: The ID of the user that created the note.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- author:
- description: The details of the user that created the note.
- x-expandable: author
- nullable: true
- $ref: ./User.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
diff --git a/www/apps/api-reference/specs/store/components/schemas/Notification.yaml b/www/apps/api-reference/specs/store/components/schemas/Notification.yaml
deleted file mode 100644
index 0d00e6fed4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Notification.yaml
+++ /dev/null
@@ -1,93 +0,0 @@
-title: Notification
-description: >-
- A notification is an alert sent, typically to customers, using the installed
- Notification Provider as a reaction to internal events such as `order.placed`.
- Notifications can be resent.
-type: object
-required:
- - created_at
- - customer_id
- - data
- - event_name
- - id
- - parent_id
- - provider_id
- - resource_type
- - resource_id
- - to
- - updated_at
-properties:
- id:
- description: The notification's ID
- type: string
- example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
- event_name:
- description: The name of the event that the notification was sent for.
- nullable: true
- type: string
- example: order.placed
- resource_type:
- description: The type of resource that the Notification refers to.
- type: string
- example: order
- resource_id:
- description: The ID of the resource that the Notification refers to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- customer_id:
- description: The ID of the customer that this notification was sent to.
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer that this notification was sent to.
- x-expandable: customer
- nullable: true
- $ref: ./Customer.yaml
- to:
- description: >-
- The address that the Notification was sent to. This will usually be an
- email address, but can represent other addresses such as a chat bot user
- ID.
- type: string
- example: user@example.com
- data:
- description: >-
- The data that the Notification was sent with. This contains all the data
- necessary for the Notification Provider to initiate a resend.
- type: object
- example: {}
- parent_id:
- description: The notification's parent ID
- nullable: true
- type: string
- example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
- parent_notification:
- description: The details of the parent notification.
- x-expandable: parent_notification
- nullable: true
- type: object
- resends:
- description: The details of all resends of the notification.
- type: array
- x-expandable: resends
- items:
- type: object
- provider_id:
- description: The ID of the notification provider used to send the notification.
- nullable: true
- type: string
- example: sengrid
- provider:
- description: The notification provider used to send the notification.
- x-expandable: provider
- nullable: true
- $ref: ./NotificationProvider.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/NotificationProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/NotificationProvider.yaml
deleted file mode 100644
index d2d2e53288..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/NotificationProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Notification Provider
-description: >-
- A notification provider represents a notification service installed in the
- Medusa backend, either through a plugin or backend customizations. It holds
- the notification service's installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the notification provider as given by the notification service.
- type: string
- example: sendgrid
- is_installed:
- description: >-
- Whether the notification service is installed in the current version. If a
- notification service is no longer installed, the `is_installed` attribute
- is set to `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/store/components/schemas/OAuth.yaml b/www/apps/api-reference/specs/store/components/schemas/OAuth.yaml
deleted file mode 100644
index b1ca6bf402..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/OAuth.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-title: OAuth
-description: >-
- An Oauth app is typically created by a plugin to handle authentication to
- third-party services.
-type: object
-required:
- - application_name
- - data
- - display_name
- - id
- - install_url
- - uninstall_url
-properties:
- id:
- description: The app's ID
- type: string
- example: example_app
- display_name:
- description: The app's display name
- type: string
- example: Example app
- application_name:
- description: The app's name
- type: string
- example: example
- install_url:
- description: The URL to install the app
- nullable: true
- type: string
- format: uri
- uninstall_url:
- description: The URL to uninstall the app
- nullable: true
- type: string
- format: uri
- data:
- description: Any data necessary to the app.
- nullable: true
- type: object
- example: {}
diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml
deleted file mode 100644
index 9fb3daeff9..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml
+++ /dev/null
@@ -1,349 +0,0 @@
-title: Order
-description: >-
- An order is a purchase made by a customer. It holds details about payment and
- fulfillment of the order. An order may also be created from a draft order,
- which is created by an admin user.
-type: object
-required:
- - billing_address_id
- - canceled_at
- - cart_id
- - created_at
- - currency_code
- - customer_id
- - draft_order_id
- - display_id
- - email
- - external_id
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - object
- - payment_status
- - region_id
- - shipping_address_id
- - status
- - tax_rate
- - updated_at
-properties:
- id:
- description: The order's ID
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- status:
- description: The order's status
- type: string
- enum:
- - pending
- - completed
- - archived
- - canceled
- - requires_action
- default: pending
- fulfillment_status:
- description: The order's fulfillment status
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- default: not_fulfilled
- payment_status:
- description: The order's payment status
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - partially_refunded
- - refunded
- - canceled
- - requires_action
- default: not_paid
- display_id:
- description: The order's display ID
- type: integer
- example: 2
- cart_id:
- description: The ID of the cart associated with the order
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart associated with the order.
- x-expandable: cart
- nullable: true
- type: object
- customer_id:
- description: The ID of the customer associated with the order
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer associated with the order.
- x-expandable: customer
- nullable: true
- type: object
- email:
- description: The email associated with the order
- type: string
- format: email
- billing_address_id:
- description: The ID of the billing address associated with the order
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the order.
- x-expandable: billing_address
- nullable: true
- $ref: ./Address.yaml
- shipping_address_id:
- description: The ID of the shipping address associated with the order
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address associated with the order.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- region_id:
- description: The ID of the region this order was created in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this order was created in.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- currency_code:
- description: The 3 character currency code that is used in the order
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency used in the order.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- tax_rate:
- description: The order's tax rate
- nullable: true
- type: number
- example: 0
- discounts:
- description: The details of the discounts applied on the order.
- type: array
- x-expandable: discounts
- items:
- $ref: ./Discount.yaml
- gift_cards:
- description: The details of the gift card used in the order.
- type: array
- x-expandable: gift_cards
- items:
- $ref: ./GiftCard.yaml
- shipping_methods:
- description: The details of the shipping methods used in the order.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- payments:
- description: The details of the payments used in the order.
- type: array
- x-expandable: payments
- items:
- type: object
- fulfillments:
- description: The details of the fulfillments created for the order.
- type: array
- x-expandable: fulfillments
- items:
- type: object
- returns:
- description: The details of the returns created for the order.
- type: array
- x-expandable: returns
- items:
- type: object
- claims:
- description: The details of the claims created for the order.
- type: array
- x-expandable: claims
- items:
- type: object
- refunds:
- description: The details of the refunds created for the order.
- type: array
- x-expandable: refunds
- items:
- type: object
- swaps:
- description: The details of the swaps created for the order.
- type: array
- x-expandable: swaps
- items:
- type: object
- draft_order_id:
- description: The ID of the draft order this order was created from.
- nullable: true
- type: string
- example: null
- draft_order:
- description: The details of the draft order this order was created from.
- x-expandable: draft_order
- nullable: true
- type: object
- items:
- description: The details of the line items that belong to the order.
- x-expandable: items
- type: array
- items:
- $ref: ./LineItem.yaml
- edits:
- description: The details of the order edits done on the order.
- type: array
- x-expandable: edits
- items:
- type: object
- gift_card_transactions:
- description: The gift card transactions made in the order.
- type: array
- x-expandable: gift_card_transactions
- items:
- $ref: ./GiftCardTransaction.yaml
- canceled_at:
- description: The date the order was canceled on.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: >-
- Flag for describing whether or not notifications related to this should be
- send.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the processing of the order in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- external_id:
- description: The ID of an external order.
- nullable: true
- type: string
- example: null
- sales_channel_id:
- description: The ID of the sales channel this order belongs to.
- nullable: true
- type: string
- example: null
- sales_channel:
- description: The details of the sales channel this order belongs to.
- x-expandable: sales_channel
- nullable: true
- $ref: ./SalesChannel.yaml
- shipping_total:
- type: integer
- description: The total of shipping
- example: 1000
- nullable: true
- shipping_tax_total:
- type: integer
- description: The tax total applied on shipping
- example: 1000
- raw_discount_total:
- description: The total of discount
- type: integer
- example: 800
- discount_total:
- description: The total of discount rounded
- type: integer
- example: 800
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- item_tax_total:
- description: The tax total applied on items
- type: integer
- example: 0
- nullable: true
- refunded_total:
- description: The total amount refunded if the order is returned.
- type: integer
- example: 0
- total:
- description: The total amount of the order
- type: integer
- example: 8200
- subtotal:
- description: The subtotal of the order
- type: integer
- example: 8000
- paid_total:
- description: The total amount paid
- type: integer
- example: 8000
- refundable_amount:
- description: The amount that can be refunded
- type: integer
- example: 8200
- gift_card_total:
- description: The total of gift cards
- type: integer
- example: 0
- gift_card_tax_total:
- description: The total of gift cards with taxes
- type: integer
- example: 0
- returnable_items:
- description: >-
- The details of the line items that are returnable as part of the order,
- swaps, or claims
- type: array
- x-expandable: returnable_items
- items:
- $ref: ./LineItem.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- sales_channels:
- description: The associated sales channels.
- type: array
- nullable: true
- x-expandable: sales_channels
- x-featureFlag: medusa_v2
- items:
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderEdit.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderEdit.yaml
deleted file mode 100644
index 27f1077bdb..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/OrderEdit.yaml
+++ /dev/null
@@ -1,170 +0,0 @@
-title: Order Edit
-description: >-
- Order edit allows modifying items in an order, such as adding, updating, or
- deleting items from the original order. Once the order edit is confirmed, the
- changes are reflected on the original order.
-type: object
-required:
- - canceled_at
- - canceled_by
- - confirmed_by
- - confirmed_at
- - created_at
- - created_by
- - declined_at
- - declined_by
- - declined_reason
- - id
- - internal_note
- - order_id
- - payment_collection_id
- - requested_at
- - requested_by
- - status
- - updated_at
-properties:
- id:
- description: The order edit's ID
- type: string
- example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
- order_id:
- description: The ID of the order that is edited
- type: string
- example: order_01G2SG30J8C85S4A5CHM2S1NS2
- order:
- description: The details of the order that this order edit was created for.
- x-expandable: order
- nullable: true
- type: object
- changes:
- description: The details of all the changes on the original order's line items.
- x-expandable: changes
- type: array
- items:
- $ref: ./OrderItemChange.yaml
- internal_note:
- description: An optional note with additional details about the order edit.
- nullable: true
- type: string
- example: Included two more items B to the order.
- created_by:
- description: The unique identifier of the user or customer who created the order edit.
- type: string
- requested_by:
- description: >-
- The unique identifier of the user or customer who requested the order
- edit.
- nullable: true
- type: string
- requested_at:
- description: The date with timezone at which the edit was requested.
- nullable: true
- type: string
- format: date-time
- confirmed_by:
- description: >-
- The unique identifier of the user or customer who confirmed the order
- edit.
- nullable: true
- type: string
- confirmed_at:
- description: The date with timezone at which the edit was confirmed.
- nullable: true
- type: string
- format: date-time
- declined_by:
- description: The unique identifier of the user or customer who declined the order edit.
- nullable: true
- type: string
- declined_at:
- description: The date with timezone at which the edit was declined.
- nullable: true
- type: string
- format: date-time
- declined_reason:
- description: An optional note why the order edit is declined.
- nullable: true
- type: string
- canceled_by:
- description: >-
- The unique identifier of the user or customer who cancelled the order
- edit.
- nullable: true
- type: string
- canceled_at:
- description: The date with timezone at which the edit was cancelled.
- nullable: true
- type: string
- format: date-time
- subtotal:
- description: The total of subtotal
- type: integer
- example: 8000
- discount_total:
- description: The total of discount
- type: integer
- example: 800
- shipping_total:
- description: The total of the shipping amount
- type: integer
- example: 800
- gift_card_total:
- description: The total of the gift card amount
- type: integer
- example: 800
- gift_card_tax_total:
- description: The total of the gift card tax amount
- type: integer
- example: 800
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- total:
- description: The total amount of the edited order.
- type: integer
- example: 8200
- difference_due:
- description: >-
- The difference between the total amount of the order and total amount of
- edited order.
- type: integer
- example: 8200
- status:
- description: The status of the order edit.
- type: string
- enum:
- - confirmed
- - declined
- - requested
- - created
- - canceled
- items:
- description: >-
- The details of the cloned items from the original order with the new
- changes. Once the order edit is confirmed, these line items are associated
- with the original order.
- type: array
- x-expandable: items
- items:
- $ref: ./LineItem.yaml
- payment_collection_id:
- description: The ID of the payment collection
- nullable: true
- type: string
- example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
- payment_collection:
- description: >-
- The details of the payment collection used to authorize additional payment
- if necessary.
- x-expandable: payment_collection
- nullable: true
- $ref: ./PaymentCollection.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderItemChange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderItemChange.yaml
deleted file mode 100644
index a1cbe55425..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/OrderItemChange.yaml
+++ /dev/null
@@ -1,73 +0,0 @@
-title: Order Item Change
-description: >-
- An order item change is a change made within an order edit to an order's
- items. These changes are not reflected on the original order until the order
- edit is confirmed.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - line_item_id
- - order_edit_id
- - original_line_item_id
- - type
- - updated_at
-properties:
- id:
- description: The order item change's ID
- type: string
- example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
- type:
- description: The order item change's status
- type: string
- enum:
- - item_add
- - item_remove
- - item_update
- order_edit_id:
- description: The ID of the order edit
- type: string
- example: oe_01G2SG30J8C85S4A5CHM2S1NS2
- order_edit:
- description: The details of the order edit the item change is associated with.
- x-expandable: order_edit
- nullable: true
- type: object
- original_line_item_id:
- description: The ID of the original line item in the order
- nullable: true
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- original_line_item:
- description: >-
- The details of the original line item this item change references. This is
- used if the item change updates or deletes the original item.
- x-expandable: original_line_item
- nullable: true
- $ref: ./LineItem.yaml
- line_item_id:
- description: The ID of the cloned line item.
- nullable: true
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- line_item:
- description: >-
- The details of the resulting line item after the item change. This line
- item is then used in the original order once the order edit is confirmed.
- x-expandable: line_item
- nullable: true
- $ref: ./LineItem.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/Payment.yaml b/www/apps/api-reference/specs/store/components/schemas/Payment.yaml
deleted file mode 100644
index cf84c788ad..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Payment.yaml
+++ /dev/null
@@ -1,133 +0,0 @@
-title: Payment
-description: >-
- A payment is originally created from a payment session. Once a payment session
- is authorized, the payment is created to represent the authorized amount with
- a given payment method. Payments can be captured, canceled or refunded.
- Payments can be made towards orders, swaps, order edits, or other resources.
-type: object
-required:
- - amount
- - amount_refunded
- - canceled_at
- - captured_at
- - cart_id
- - created_at
- - currency_code
- - data
- - id
- - idempotency_key
- - metadata
- - order_id
- - provider_id
- - swap_id
- - updated_at
-properties:
- id:
- description: The payment's ID
- type: string
- example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
- swap_id:
- description: The ID of the swap that this payment was potentially created for.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that this payment was potentially created for.
- x-expandable: swap
- nullable: true
- type: object
- cart_id:
- description: The ID of the cart that the payment session was potentially created for.
- nullable: true
- type: string
- cart:
- description: >-
- The details of the cart that the payment session was potentially created
- for.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the payment session was potentially created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: >-
- The details of the order that the payment session was potentially created
- for.
- x-expandable: order
- nullable: true
- type: object
- amount:
- description: The amount that the Payment has been authorized for.
- type: integer
- example: 100
- currency_code:
- description: The 3 character ISO currency code of the payment.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency of the payment.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- amount_refunded:
- description: >-
- The amount of the original Payment amount that has been refunded back to
- the Customer.
- type: integer
- default: 0
- example: 0
- provider_id:
- description: The id of the Payment Provider that is responsible for the Payment
- type: string
- example: manual
- data:
- description: >-
- The data required for the Payment Provider to identify, modify and process
- the Payment. Typically this will be an object that holds an id to the
- external payment session, but can be an empty object if the Payment
- Provider doesn't hold any state.
- type: object
- example: {}
- captured_at:
- description: The date with timezone at which the Payment was captured.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date with timezone at which the Payment was canceled.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a payment in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml
deleted file mode 100644
index 4c8342dae9..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PaymentCollection.yaml
+++ /dev/null
@@ -1,113 +0,0 @@
-title: Payment Collection
-description: >-
- A payment collection allows grouping and managing a list of payments at one.
- This can be helpful when making additional payment for order edits or
- integrating installment payments.
-type: object
-required:
- - amount
- - authorized_amount
- - created_at
- - created_by
- - currency_code
- - deleted_at
- - description
- - id
- - metadata
- - region_id
- - status
- - type
- - updated_at
-properties:
- id:
- description: The payment collection's ID
- type: string
- example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
- type:
- description: The type of the payment collection
- type: string
- enum:
- - order_edit
- status:
- description: The type of the payment collection
- type: string
- enum:
- - not_paid
- - awaiting
- - authorized
- - partially_authorized
- - canceled
- description:
- description: Description of the payment collection
- nullable: true
- type: string
- amount:
- description: Amount of the payment collection.
- type: integer
- authorized_amount:
- description: Authorized amount of the payment collection.
- nullable: true
- type: integer
- region_id:
- description: The ID of the region this payment collection is associated with.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this payment collection is associated with.
- x-expandable: region
- nullable: true
- $ref: ./Region.yaml
- currency_code:
- description: >-
- The three character ISO code for the currency this payment collection is
- associated with.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency this payment collection is associated with.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- payment_sessions:
- description: >-
- The details of the payment sessions created as part of the payment
- collection.
- type: array
- x-expandable: payment_sessions
- items:
- $ref: ./PaymentSession.yaml
- payments:
- description: The details of the payments created as part of the payment collection.
- type: array
- x-expandable: payments
- items:
- $ref: ./Payment.yaml
- created_by:
- description: The ID of the user that created the payment collection.
- type: string
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/PaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/PaymentProvider.yaml
deleted file mode 100644
index 4a54a90729..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PaymentProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Payment Provider
-description: >-
- A payment provider represents a payment service installed in the Medusa
- backend, either through a plugin or backend customizations. It holds the
- payment service's installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the payment provider as given by the payment service.
- type: string
- example: manual
- is_installed:
- description: >-
- Whether the payment service is installed in the current version. If a
- payment service is no longer installed, the `is_installed` attribute is
- set to `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/store/components/schemas/PaymentSession.yaml b/www/apps/api-reference/specs/store/components/schemas/PaymentSession.yaml
deleted file mode 100644
index ccf7cbcda8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PaymentSession.yaml
+++ /dev/null
@@ -1,105 +0,0 @@
-title: Payment Session
-description: >-
- A Payment Session is created when a Customer initilizes the checkout flow, and
- can be used to hold the state of a payment flow. Each Payment Session is
- controlled by a Payment Provider, which is responsible for the communication
- with external payment services. Authorized Payment Sessions will eventually
- get promoted to Payments to indicate that they are authorized for payment
- processing such as capture or refund. Payment sessions can also be used as
- part of payment collections.
-type: object
-required:
- - amount
- - cart_id
- - created_at
- - data
- - id
- - is_initiated
- - is_selected
- - idempotency_key
- - payment_authorized_at
- - provider_id
- - status
- - updated_at
-properties:
- id:
- description: The payment session's ID
- type: string
- example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
- cart_id:
- description: The ID of the cart that the payment session was created for.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the payment session was created for.
- x-expandable: cart
- nullable: true
- $ref: ./Cart.yaml
- provider_id:
- description: The ID of the Payment Provider that is responsible for the Payment Session
- type: string
- example: manual
- is_selected:
- description: >-
- A flag to indicate if the Payment Session has been selected as the method
- that will be used to complete the purchase.
- nullable: true
- type: boolean
- example: true
- is_initiated:
- description: >-
- A flag to indicate if a communication with the third party provider has
- been initiated.
- type: boolean
- default: false
- example: true
- status:
- description: >-
- Indicates the status of the Payment Session. Will default to `pending`,
- and will eventually become `authorized`. Payment Sessions may have the
- status of `requires_more` to indicate that further actions are to be
- completed by the Customer.
- type: string
- enum:
- - authorized
- - pending
- - requires_more
- - error
- - canceled
- example: pending
- data:
- description: >-
- The data required for the Payment Provider to identify, modify and process
- the Payment Session. Typically this will be an object that holds an id to
- the external payment session, but can be an empty object if the Payment
- Provider doesn't hold any state.
- type: object
- example: {}
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a cart in case
- of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- amount:
- description: The amount that the Payment Session has been authorized for.
- nullable: true
- type: integer
- example: 100
- payment_authorized_at:
- description: The date with timezone at which the Payment Session was authorized.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/PriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/PriceList.yaml
deleted file mode 100644
index cb1f79566a..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PriceList.yaml
+++ /dev/null
@@ -1,83 +0,0 @@
-title: Price List
-description: >-
- A Price List represents a set of prices that override the default price for
- one or more product variants.
-type: object
-required:
- - created_at
- - deleted_at
- - description
- - ends_at
- - id
- - name
- - starts_at
- - status
- - type
- - updated_at
-properties:
- id:
- description: The price list's ID
- type: string
- example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
- name:
- description: The price list's name
- type: string
- example: VIP Prices
- description:
- description: The price list's description
- type: string
- example: Prices for VIP customers
- type:
- description: The type of Price List. This can be one of either `sale` or `override`.
- type: string
- enum:
- - sale
- - override
- default: sale
- status:
- description: The status of the Price List
- type: string
- enum:
- - active
- - draft
- default: draft
- starts_at:
- description: The date with timezone that the Price List starts being valid.
- nullable: true
- type: string
- format: date-time
- ends_at:
- description: The date with timezone that the Price List stops being valid.
- nullable: true
- type: string
- format: date-time
- customer_groups:
- description: The details of the customer groups that the Price List can apply to.
- type: array
- x-expandable: customer_groups
- items:
- $ref: ./CustomerGroup.yaml
- prices:
- description: The prices that belong to the price list, represented as a Money Amount.
- type: array
- x-expandable: prices
- items:
- $ref: ./MoneyAmount.yaml
- includes_tax:
- description: Whether the price list prices include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml
deleted file mode 100644
index aa57632b38..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PricedProduct.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-title: Priced Product
-type: object
-allOf:
- - $ref: ./Product.yaml
- - type: object
- properties:
- variants:
- description: The product variants and their prices.
- type: array
- items:
- $ref: ./PricedVariant.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/PricedShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/PricedShippingOption.yaml
deleted file mode 100644
index a5f479328b..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PricedShippingOption.yaml
+++ /dev/null
@@ -1,27 +0,0 @@
-title: Priced Shipping Option
-type: object
-allOf:
- - $ref: ./ShippingOption.yaml
- - type: object
- properties:
- price_incl_tax:
- type: number
- description: Price including taxes
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
- tax_amount:
- type: number
- description: The taxes applied.
diff --git a/www/apps/api-reference/specs/store/components/schemas/PricedVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/PricedVariant.yaml
deleted file mode 100644
index 4b74691549..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PricedVariant.yaml
+++ /dev/null
@@ -1,41 +0,0 @@
-title: Priced Product Variant
-type: object
-allOf:
- - $ref: ./ProductVariant.yaml
- - type: object
- properties:
- original_price:
- type: number
- description: >-
- The original price of the variant without any discounted prices
- applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
diff --git a/www/apps/api-reference/specs/store/components/schemas/Product.yaml b/www/apps/api-reference/specs/store/components/schemas/Product.yaml
deleted file mode 100644
index d0f98a63f1..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Product.yaml
+++ /dev/null
@@ -1,253 +0,0 @@
-title: Product
-description: >-
- A product is a saleable item that holds general information such as name or
- description. It must include at least one Product Variant, where each product
- variant defines different options to purchase the product with (for example,
- different sizes or colors). The prices and inventory of the product are
- defined on the variant level.
-type: object
-required:
- - collection_id
- - created_at
- - deleted_at
- - description
- - discountable
- - external_id
- - handle
- - height
- - hs_code
- - id
- - is_giftcard
- - length
- - material
- - metadata
- - mid_code
- - origin_country
- - profile_id
- - status
- - subtitle
- - type_id
- - thumbnail
- - title
- - updated_at
- - weight
- - width
-properties:
- id:
- description: The product's ID
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- title:
- description: A title that can be displayed for easy identification of the Product.
- type: string
- example: Medusa Coffee Mug
- subtitle:
- description: An optional subtitle that can be used to further specify the Product.
- nullable: true
- type: string
- description:
- description: A short description of the Product.
- nullable: true
- type: string
- example: Every programmer's best friend.
- handle:
- description: A unique identifier for the Product (e.g. for slug structure).
- nullable: true
- type: string
- example: coffee-mug
- is_giftcard:
- description: >-
- Whether the Product represents a Gift Card. Products that represent Gift
- Cards will automatically generate a redeemable Gift Card code once they
- are purchased.
- type: boolean
- default: false
- status:
- description: The status of the product
- type: string
- enum:
- - draft
- - proposed
- - published
- - rejected
- default: draft
- images:
- description: The details of the product's images.
- type: array
- x-expandable: images
- items:
- $ref: ./Image.yaml
- thumbnail:
- description: A URL to an image file that can be used to identify the Product.
- nullable: true
- type: string
- format: uri
- options:
- description: >-
- The details of the Product Options that are defined for the Product. The
- product's variants will have a unique combination of values of the
- product's options.
- type: array
- x-expandable: options
- items:
- $ref: ./ProductOption.yaml
- variants:
- description: >-
- The details of the Product Variants that belong to the Product. Each will
- have a unique combination of values of the product's options.
- type: array
- x-expandable: variants
- items:
- $ref: ./ProductVariant.yaml
- categories:
- description: The details of the product categories that this product belongs to.
- type: array
- x-expandable: categories
- x-featureFlag: product_categories
- items:
- $ref: ./ProductCategory.yaml
- profile_id:
- description: >-
- The ID of the shipping profile that the product belongs to. The shipping
- profile has a set of defined shipping options that can be used to fulfill
- the product.
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- profile:
- description: >-
- The details of the shipping profile that the product belongs to. The
- shipping profile has a set of defined shipping options that can be used to
- fulfill the product.
- x-expandable: profile
- nullable: true
- $ref: ./ShippingProfile.yaml
- profiles:
- description: Available if the relation `profiles` is expanded.
- nullable: true
- type: array
- items:
- $ref: ./ShippingProfile.yaml
- weight:
- description: >-
- The weight of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- length:
- description: >-
- The length of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- height:
- description: >-
- The height of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- width:
- description: >-
- The width of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- hs_code:
- description: >-
- The Harmonized System code of the Product Variant. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- origin_country:
- description: >-
- The country in which the Product Variant was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Product Variant. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
- nullable: true
- type: string
- example: null
- material:
- description: >-
- The material and composition that the Product Variant is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
- nullable: true
- type: string
- example: null
- collection_id:
- description: The ID of the product collection that the product belongs to.
- nullable: true
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- collection:
- description: The details of the product collection that the product belongs to.
- x-expandable: collection
- nullable: true
- $ref: ./ProductCollection.yaml
- type_id:
- description: The ID of the product type that the product belongs to.
- nullable: true
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- type:
- description: The details of the product type that the product belongs to.
- x-expandable: type
- nullable: true
- $ref: ./ProductType.yaml
- tags:
- description: The details of the product tags used in this product.
- type: array
- x-expandable: type
- items:
- $ref: ./ProductTag.yaml
- discountable:
- description: >-
- Whether the Product can be discounted. Discounts will not apply to Line
- Items of this Product when this flag is set to `false`.
- type: boolean
- default: true
- external_id:
- description: The external ID of the product
- nullable: true
- type: string
- example: null
- sales_channels:
- description: The details of the sales channels this product is available in.
- type: array
- x-expandable: sales_channels
- items:
- $ref: ./SalesChannel.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml
deleted file mode 100644
index 2a9d4d63a0..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductCategory.yaml
+++ /dev/null
@@ -1,97 +0,0 @@
-title: Product Category
-description: >-
- A product category can be used to categorize products into a hierarchy of
- categories.
-x-resourceId: ProductCategory
-x-featureFlag: product_categories
-type: object
-required:
- - category_children
- - created_at
- - handle
- - id
- - is_active
- - is_internal
- - metadata
- - mpath
- - name
- - parent_category_id
- - updated_at
-properties:
- id:
- description: The product category's ID
- type: string
- example: pcat_01G2SG30J8C85S4A5CHM2S1NS2
- name:
- description: The product category's name
- type: string
- example: Regular Fit
- description:
- description: The product category's description.
- type: string
- default: ''
- handle:
- description: >-
- A unique string that identifies the Product Category - can for example be
- used in slug structures.
- type: string
- example: regular-fit
- mpath:
- description: >-
- A string for Materialized Paths - used for finding ancestors and
- descendents
- nullable: true
- type: string
- example: pcat_id1.pcat_id2.pcat_id3
- is_internal:
- type: boolean
- description: A flag to make product category an internal category for admins
- default: false
- is_active:
- type: boolean
- description: A flag to make product category visible/hidden in the store front
- default: false
- rank:
- type: integer
- description: An integer that depicts the rank of category in a tree node
- default: 0
- category_children:
- description: The details of the category's children.
- type: array
- x-expandable: category_children
- items:
- type: object
- parent_category_id:
- description: The ID of the parent category.
- nullable: true
- type: string
- default: null
- parent_category:
- description: The details of the parent of this category.
- x-expandable: parent_category
- nullable: true
- type: object
- products:
- description: The details of the products that belong to this category.
- type: array
- x-expandable: products
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductCollection.yaml
deleted file mode 100644
index 82b6fbcca8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductCollection.yaml
+++ /dev/null
@@ -1,59 +0,0 @@
-title: Product Collection
-description: >-
- A Product Collection allows grouping together products for promotional
- purposes. For example, an admin can create a Summer collection, add products
- to it, and showcase it on the storefront.
-type: object
-required:
- - created_at
- - deleted_at
- - handle
- - id
- - metadata
- - title
- - updated_at
-properties:
- id:
- description: The product collection's ID
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- title:
- description: The title that the Product Collection is identified by.
- type: string
- example: Summer Collection
- handle:
- description: >-
- A unique string that identifies the Product Collection - can for example
- be used in slug structures.
- nullable: true
- type: string
- example: summer-collection
- products:
- description: The details of the products that belong to this product collection.
- type: array
- x-expandable: products
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductOption.yaml
deleted file mode 100644
index 6e2d829a9e..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductOption.yaml
+++ /dev/null
@@ -1,61 +0,0 @@
-title: Product Option
-description: >-
- A Product Option defines properties that may vary between different variants
- of a Product. Common Product Options are "Size" and "Color". Admins are free
- to create any product options.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - product_id
- - title
- - updated_at
-properties:
- id:
- description: The product option's ID
- type: string
- example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
- title:
- description: The title that the Product Option is defined by (e.g. `Size`).
- type: string
- example: Size
- values:
- description: The details of the values of the product option.
- type: array
- x-expandable: values
- items:
- $ref: ./ProductOptionValue.yaml
- product_id:
- description: The ID of the product that this product option belongs to.
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product that this product option belongs to.
- x-expandable: product
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductOptionValue.yaml
deleted file mode 100644
index af9257805c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductOptionValue.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-title: Product Option Value
-description: >-
- An option value is one of the possible values of a Product Option. Product
- Variants specify a unique combination of product option values.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - option_id
- - updated_at
- - value
- - variant_id
-properties:
- id:
- description: The product option value's ID
- type: string
- example: optval_01F0YESHR7S6ECD03RF6W12DSJ
- value:
- description: >-
- The value that the Product Variant has defined for the specific Product
- Option (e.g. if the Product Option is "Size" this value could be `Small`,
- `Medium` or `Large`).
- type: string
- example: large
- option_id:
- description: The ID of the Product Option that the Product Option Value belongs to.
- type: string
- example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
- option:
- description: >-
- The details of the product option that the Product Option Value belongs
- to.
- x-expandable: option
- nullable: true
- type: object
- variant_id:
- description: The ID of the product variant that uses this product option value.
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that uses this product option value.
- x-expandable: variant
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductTag.yaml
deleted file mode 100644
index 829162f285..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductTag.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-title: Product Tag
-description: A Product Tag can be added to Products for easy filtering and grouping.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
-properties:
- id:
- description: The product tag's ID
- type: string
- example: ptag_01G8K2MTMG9168F2B70S1TAVK3
- value:
- description: The value that the Product Tag represents
- type: string
- example: Pants
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductTaxRate.yaml
deleted file mode 100644
index 55292d8e33..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductTaxRate.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Tax Rate
-description: >-
- This represents the association between a tax rate and a product to indicate
- that the product is taxed in a way different than the default.
-type: object
-required:
- - created_at
- - metadata
- - product_id
- - rate_id
- - updated_at
-properties:
- product_id:
- description: The ID of the Product
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product.
- x-expandable: product
- nullable: true
- $ref: ./Product.yaml
- rate_id:
- description: The ID of the Tax Rate
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: ./TaxRate.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductType.yaml
deleted file mode 100644
index dbdc684090..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductType.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-title: Product Type
-description: A Product Type can be added to Products for filtering and reporting purposes.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
-properties:
- id:
- description: The product type's ID
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- value:
- description: The value that the Product Type represents.
- type: string
- example: Clothing
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductTypeTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductTypeTaxRate.yaml
deleted file mode 100644
index 3c641ab1fe..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductTypeTaxRate.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-title: Product Type Tax Rate
-description: >-
- This represents the association between a tax rate and a product type to
- indicate that the product type is taxed in a different way than the default.
-type: object
-required:
- - created_at
- - metadata
- - product_type_id
- - rate_id
- - updated_at
-properties:
- product_type_id:
- description: The ID of the Product type
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_type:
- description: The details of the product type.
- x-expandable: product_type
- nullable: true
- $ref: ./ProductType.yaml
- rate_id:
- description: The id of the Tax Rate
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: ./TaxRate.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductVariant.yaml
deleted file mode 100644
index ad7ee83ce8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductVariant.yaml
+++ /dev/null
@@ -1,208 +0,0 @@
-title: Product Variant
-description: >-
- A Product Variant represents a Product with a specific set of Product Option
- configurations. The maximum number of Product Variants that a Product can have
- is given by the number of available Product Option combinations. A product
- must at least have one product variant.
-type: object
-required:
- - allow_backorder
- - barcode
- - created_at
- - deleted_at
- - ean
- - height
- - hs_code
- - id
- - inventory_quantity
- - length
- - manage_inventory
- - material
- - metadata
- - mid_code
- - origin_country
- - product_id
- - sku
- - title
- - upc
- - updated_at
- - weight
- - width
-properties:
- id:
- description: The product variant's ID
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- title:
- description: >-
- A title that can be displayed for easy identification of the Product
- Variant.
- type: string
- example: Small
- product_id:
- description: The ID of the product that the product variant belongs to.
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product that the product variant belongs to.
- x-expandable: product
- nullable: true
- type: object
- prices:
- description: >-
- The details of the prices of the Product Variant, each represented as a
- Money Amount. Each Money Amount represents a price in a given currency or
- a specific Region.
- type: array
- x-expandable: prices
- items:
- $ref: ./MoneyAmount.yaml
- sku:
- description: >-
- The unique stock keeping unit used to identify the Product Variant. This
- will usually be a unique identifer for the item that is to be shipped, and
- can be referenced across multiple systems.
- nullable: true
- type: string
- example: shirt-123
- barcode:
- description: >-
- A generic field for a GTIN number that can be used to identify the Product
- Variant.
- nullable: true
- type: string
- example: null
- ean:
- description: An EAN barcode number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- upc:
- description: A UPC barcode number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- variant_rank:
- description: The ranking of this variant
- nullable: true
- type: number
- default: 0
- inventory_quantity:
- description: The current quantity of the item that is stocked.
- type: integer
- example: 100
- allow_backorder:
- description: >-
- Whether the Product Variant should be purchasable when
- `inventory_quantity` is 0.
- type: boolean
- default: false
- manage_inventory:
- description: Whether Medusa should manage inventory for the Product Variant.
- type: boolean
- default: true
- hs_code:
- description: >-
- The Harmonized System code of the Product Variant. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- origin_country:
- description: >-
- The country in which the Product Variant was produced. May be used by
- Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- mid_code:
- description: >-
- The Manufacturers Identification code that identifies the manufacturer of
- the Product Variant. May be used by Fulfillment Providers to pass customs
- information to shipping carriers.
- nullable: true
- type: string
- example: null
- material:
- description: >-
- The material and composition that the Product Variant is made of, May be
- used by Fulfillment Providers to pass customs information to shipping
- carriers.
- nullable: true
- type: string
- example: null
- weight:
- description: >-
- The weight of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- length:
- description: >-
- The length of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- height:
- description: >-
- The height of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- width:
- description: >-
- The width of the Product Variant. May be used in shipping rate
- calculations.
- nullable: true
- type: number
- example: null
- options:
- description: >-
- The details of the product options that this product variant defines
- values for.
- type: array
- x-expandable: options
- items:
- $ref: ./ProductOptionValue.yaml
- inventory_items:
- description: The details inventory items of the product variant.
- type: array
- x-expandable: inventory_items
- items:
- $ref: ./ProductVariantInventoryItem.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- purchasable:
- description: |
- Only used with the inventory modules.
- A boolean value indicating whether the Product Variant is purchasable.
- A variant is purchasable if:
- - inventory is not managed
- - it has no inventory items
- - it is in stock
- - it is backorderable.
- type: boolean
diff --git a/www/apps/api-reference/specs/store/components/schemas/ProductVariantInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/ProductVariantInventoryItem.yaml
deleted file mode 100644
index 2da5bc3821..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ProductVariantInventoryItem.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Product Variant Inventory Item
-description: >-
- A Product Variant Inventory Item links variants with inventory items and
- denotes the required quantity of the variant.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - inventory_item_id
- - required_quantity
- - updated_at
- - variant_id
-properties:
- id:
- description: The product variant inventory item's ID
- type: string
- example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
- inventory_item_id:
- description: The id of the inventory item
- type: string
- variant_id:
- description: The id of the variant.
- type: string
- variant:
- description: The details of the product variant.
- x-expandable: variant
- nullable: true
- type: object
- required_quantity:
- description: The quantity of an inventory item required for the variant.
- type: integer
- default: 1
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/Promotion.yaml b/www/apps/api-reference/specs/store/components/schemas/Promotion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/Promotion.yaml
rename to www/apps/api-reference/specs/store/components/schemas/Promotion.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/PromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/PromotionRule.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/PromotionRule.yaml
rename to www/apps/api-reference/specs/store/components/schemas/PromotionRule.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/PublishableApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/PublishableApiKey.yaml
deleted file mode 100644
index d94df58632..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PublishableApiKey.yaml
+++ /dev/null
@@ -1,49 +0,0 @@
-title: Publishable API key
-description: >-
- A Publishable API key defines scopes that resources are available in. Then, it
- can be used in request to infer the resources without having to directly pass
- them. For example, a publishable API key can be associated with one or more
- sales channels. Then, when the publishable API key is passed in the header of
- a request, it is inferred what sales channel is being used without having to
- pass the sales channel as a query or body parameter of the request.
- Publishable API keys can only be used with sales channels, at the moment.
-type: object
-required:
- - created_at
- - created_by
- - id
- - revoked_by
- - revoked_at
- - title
- - updated_at
-properties:
- id:
- description: The key's ID
- type: string
- example: pk_01G1G5V27GYX4QXNARRQCW1N8T
- created_by:
- description: The unique identifier of the user that created the key.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- revoked_by:
- description: The unique identifier of the user that revoked the key.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- revoked_at:
- description: The date with timezone at which the key was revoked.
- nullable: true
- type: string
- format: date-time
- title:
- description: The key's title.
- type: string
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/PublishableApiKeySalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/PublishableApiKeySalesChannel.yaml
deleted file mode 100644
index fc7419a6d8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/PublishableApiKeySalesChannel.yaml
+++ /dev/null
@@ -1,37 +0,0 @@
-title: Publishable API Key Sales Channel
-description: >-
- This represents the association between the Publishable API keys and Sales
- Channels
-type: object
-required:
- - publishable_key_id
- - sales_channel_id
- - created_at
- - updated_at
- - deleted_at
-properties:
- id:
- description: The relation's ID
- type: string
- example: pksc_01G8X9A7ESKAJXG2H0E6F1MW7A
- sales_channel_id:
- description: The sales channel's ID
- type: string
- example: sc_01G1G5V21KADXNGH29BJMAJ4B4
- publishable_key_id:
- description: The publishable API key's ID
- type: string
- example: pak_01G1G5V21KADXNGH29BJMAJ4B4
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/Refund.yaml b/www/apps/api-reference/specs/store/components/schemas/Refund.yaml
deleted file mode 100644
index 0438bfe295..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Refund.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-title: Refund
-description: >-
- A refund represents an amount of money transfered back to the customer for a
- given reason. Refunds may occur in relation to Returns, Swaps and Claims, but
- can also be initiated by an admin for an order.
-type: object
-required:
- - amount
- - created_at
- - id
- - idempotency_key
- - metadata
- - note
- - order_id
- - payment_id
- - reason
- - updated_at
-properties:
- id:
- description: The refund's ID
- type: string
- example: ref_01G1G5V27GYX4QXNARRQCW1N8T
- order_id:
- description: The ID of the order this refund was created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order this refund was created for.
- x-expandable: order
- nullable: true
- type: object
- payment_id:
- description: The payment's ID, if available.
- nullable: true
- type: string
- example: pay_01G8ZCC5W42ZNY842124G7P5R9
- payment:
- description: The details of the payment associated with the refund.
- x-expandable: payment
- nullable: true
- type: object
- amount:
- description: The amount that has be refunded to the Customer.
- type: integer
- example: 1000
- note:
- description: An optional note explaining why the amount was refunded.
- nullable: true
- type: string
- example: I didn't like it
- reason:
- description: >-
- The reason given for the Refund, will automatically be set when processed
- as part of a Swap, Claim or Return.
- type: string
- enum:
- - discount
- - return
- - swap
- - claim
- - other
- example: return
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the refund in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/Region.yaml b/www/apps/api-reference/specs/store/components/schemas/Region.yaml
deleted file mode 100644
index b9f3b0c9e3..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Region.yaml
+++ /dev/null
@@ -1,130 +0,0 @@
-title: Region
-description: >-
- A region holds settings specific to a geographical location, including the
- currency, tax rates, and fulfillment and payment providers. A Region can
- consist of multiple countries to accomodate common shopping settings across
- countries.
-type: object
-required:
- - automatic_taxes
- - created_at
- - currency_code
- - deleted_at
- - gift_cards_taxable
- - id
- - metadata
- - name
- - tax_code
- - tax_provider_id
- - tax_rate
- - updated_at
-properties:
- id:
- description: The region's ID
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- name:
- description: >-
- The name of the region as displayed to the customer. If the Region only
- has one country it is recommended to write the country name.
- type: string
- example: EU
- currency_code:
- description: The three character currency code used in the region.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency used in the region.
- x-expandable: currency
- nullable: true
- $ref: ./Currency.yaml
- tax_rate:
- description: The tax rate that should be charged on purchases in the Region.
- type: number
- example: 0
- tax_rates:
- description: >-
- The details of the tax rates used in the region, aside from the default
- rate.
- type: array
- x-expandable: tax_rates
- items:
- $ref: ./TaxRate.yaml
- tax_code:
- description: >-
- The tax code used on purchases in the Region. This may be used by other
- systems for accounting purposes.
- nullable: true
- type: string
- example: null
- gift_cards_taxable:
- description: Whether the gift cards are taxable or not in this region.
- type: boolean
- default: true
- automatic_taxes:
- description: Whether taxes should be automated in this region.
- type: boolean
- default: true
- countries:
- description: The details of the countries included in this region.
- type: array
- x-expandable: countries
- items:
- $ref: ./Country.yaml
- tax_provider_id:
- description: The ID of the tax provider used in this region
- nullable: true
- type: string
- example: null
- tax_provider:
- description: The details of the tax provider used in the region.
- x-expandable: tax_provider
- nullable: true
- $ref: ./TaxProvider.yaml
- payment_providers:
- description: >-
- The details of the payment providers that can be used to process payments
- in the region.
- type: array
- x-expandable: payment_providers
- items:
- $ref: ./PaymentProvider.yaml
- fulfillment_providers:
- description: >-
- The details of the fulfillment providers that can be used to fulfill items
- of orders and similar resources in the region.
- type: array
- x-expandable: fulfillment_providers
- items:
- $ref: ./FulfillmentProvider.yaml
- includes_tax:
- description: Whether the prices for the region include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ReservationItemDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/ReservationItemDTO.yaml
deleted file mode 100644
index 5e4f31bfec..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ReservationItemDTO.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Reservation item
-description: Represents a reservation of an inventory item at a stock location
-type: object
-required:
- - id
- - location_id
- - inventory_item_id
- - quantity
-properties:
- id:
- description: The id of the reservation item
- type: string
- location_id:
- description: The id of the location of the reservation
- type: string
- inventory_item_id:
- description: The id of the inventory item the reservation relates to
- type: string
- description:
- description: Description of the reservation item
- type: string
- created_by:
- description: UserId of user who created the reservation item
- type: string
- quantity:
- description: The id of the reservation item
- type: number
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/Return.yaml b/www/apps/api-reference/specs/store/components/schemas/Return.yaml
deleted file mode 100644
index d7145a0dff..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Return.yaml
+++ /dev/null
@@ -1,132 +0,0 @@
-title: Return
-description: >-
- A Return holds information about Line Items that a Customer wishes to send
- back, along with how the items will be returned. Returns can also be used as
- part of a Swap or a Claim.
-type: object
-required:
- - claim_order_id
- - created_at
- - id
- - idempotency_key
- - location_id
- - metadata
- - no_notification
- - order_id
- - received_at
- - refund_amount
- - shipping_data
- - status
- - swap_id
- - updated_at
-properties:
- id:
- description: The return's ID
- type: string
- example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
- status:
- description: Status of the Return.
- type: string
- enum:
- - requested
- - received
- - requires_action
- - canceled
- default: requested
- items:
- description: The details of the items that the customer is returning.
- type: array
- x-expandable: items
- items:
- $ref: ./ReturnItem.yaml
- swap_id:
- description: The ID of the swap that the return may belong to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the return may belong to.
- x-expandable: swap
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the return may belong to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the return may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the return was created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the return was created for.
- x-expandable: order
- nullable: true
- type: object
- shipping_method:
- description: >-
- The details of the Shipping Method that will be used to send the Return
- back. Can be null if the Customer will handle the return shipment
- themselves.
- x-expandable: shipping_method
- nullable: true
- $ref: ./ShippingMethod.yaml
- shipping_data:
- description: >-
- Data about the return shipment as provided by the Fulfilment Provider that
- handles the return shipment.
- nullable: true
- type: object
- example: {}
- location_id:
- description: The ID of the stock location the return will be added back.
- nullable: true
- type: string
- example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
- refund_amount:
- description: The amount that should be refunded as a result of the return.
- type: integer
- example: 1000
- no_notification:
- description: When set to true, no notification will be sent related to this return.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the return in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- received_at:
- description: The date with timezone at which the return was received.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/ReturnItem.yaml
deleted file mode 100644
index cbdf122007..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ReturnItem.yaml
+++ /dev/null
@@ -1,79 +0,0 @@
-title: Return Item
-description: >-
- A return item represents a line item in an order that is to be returned. It
- includes details related to the return and the reason behind it.
-type: object
-required:
- - is_requested
- - item_id
- - metadata
- - note
- - quantity
- - reason_id
- - received_quantity
- - requested_quantity
- - return_id
-properties:
- return_id:
- description: The ID of the Return that the Return Item belongs to.
- type: string
- example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
- item_id:
- description: The ID of the Line Item that the Return Item references.
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- return_order:
- description: Details of the Return that the Return Item belongs to.
- x-expandable: return_order
- nullable: true
- type: object
- item:
- description: The details of the line item in the original order to be returned.
- x-expandable: item
- nullable: true
- $ref: ./LineItem.yaml
- quantity:
- description: The quantity of the Line Item to be returned.
- type: integer
- example: 1
- is_requested:
- description: >-
- Whether the Return Item was requested initially or received unexpectedly
- in the warehouse.
- type: boolean
- default: true
- requested_quantity:
- description: The quantity that was originally requested to be returned.
- nullable: true
- type: integer
- example: 1
- received_quantity:
- description: The quantity that was received in the warehouse.
- nullable: true
- type: integer
- example: 1
- reason_id:
- description: The ID of the reason for returning the item.
- nullable: true
- type: string
- example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
- reason:
- description: The details of the reason for returning the item.
- x-expandable: reason
- nullable: true
- $ref: ./ReturnReason.yaml
- note:
- description: An optional note with additional details about the Return.
- nullable: true
- type: string
- example: I didn't like it.
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/ReturnReason.yaml
deleted file mode 100644
index 28f6b23324..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ReturnReason.yaml
+++ /dev/null
@@ -1,70 +0,0 @@
-title: Return Reason
-description: >-
- A Return Reason is a value defined by an admin. It can be used on Return Items
- in order to indicate why a Line Item was returned.
-type: object
-required:
- - created_at
- - deleted_at
- - description
- - id
- - label
- - metadata
- - parent_return_reason_id
- - updated_at
- - value
-properties:
- id:
- description: The return reason's ID
- type: string
- example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
- value:
- description: The value to identify the reason by.
- type: string
- example: damaged
- label:
- description: A text that can be displayed to the Customer as a reason.
- type: string
- example: Damaged goods
- description:
- description: A description of the Reason.
- nullable: true
- type: string
- example: Items that are damaged
- parent_return_reason_id:
- description: The ID of the parent reason.
- nullable: true
- type: string
- example: null
- parent_return_reason:
- description: The details of the parent reason.
- x-expandable: parent_return_reason
- nullable: true
- type: object
- return_reason_children:
- description: The details of the child reasons.
- x-expandable: return_reason_children
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/SalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/SalesChannel.yaml
deleted file mode 100644
index 1dc2968f5c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/SalesChannel.yaml
+++ /dev/null
@@ -1,84 +0,0 @@
-title: Sales Channel
-description: >-
- A Sales Channel is a method a business offers its products for purchase for
- the customers. For example, a Webshop can be a sales channel, and a mobile app
- can be another.
-type: object
-required:
- - created_at
- - deleted_at
- - description
- - id
- - is_disabled
- - name
- - updated_at
-properties:
- id:
- description: The sales channel's ID
- type: string
- example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
- name:
- description: The name of the sales channel.
- type: string
- example: Market
- description:
- description: The description of the sales channel.
- nullable: true
- type: string
- example: Multi-vendor market
- is_disabled:
- description: Specify if the sales channel is enabled or disabled.
- type: boolean
- default: false
- locations:
- description: The details of the stock locations related to the sales channel.
- type: array
- x-expandable: locations
- items:
- $ref: ./SalesChannelLocation.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
- carts:
- description: The associated carts.
- type: array
- nullable: true
- x-expandable: carts
- x-featureFlag: medusa_v2
- items:
- type: object
- orders:
- description: The associated orders.
- type: array
- nullable: true
- x-expandable: orders
- x-featureFlag: medusa_v2
- items:
- type: object
- publishableKeys:
- description: The associated publishable API keys.
- type: array
- nullable: true
- x-expandable: publishableKeys
- items:
- type: object
diff --git a/www/apps/api-reference/specs/store/components/schemas/SalesChannelLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/SalesChannelLocation.yaml
deleted file mode 100644
index 4936e19986..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/SalesChannelLocation.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-title: Sales Channel Stock Location
-description: This represents the association between a sales channel and a stock locations.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - location_id
- - sales_channel_id
- - updated_at
-properties:
- id:
- description: The Sales Channel Stock Location's ID
- type: string
- example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A
- sales_channel_id:
- description: The ID of the Sales Channel
- type: string
- example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
- location_id:
- description: The ID of the Location Stock.
- type: string
- sales_channel:
- description: The details of the sales channel the location is associated with.
- x-expandable: sales_channel
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/ShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/ShippingMethod.yaml
deleted file mode 100644
index 730bf052cd..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ShippingMethod.yaml
+++ /dev/null
@@ -1,119 +0,0 @@
-title: Shipping Method
-description: >-
- A Shipping Method represents a way in which an Order or Return can be shipped.
- Shipping Methods are created from a Shipping Option, but may contain
- additional details that can be necessary for the Fulfillment Provider to
- handle the shipment. If the shipping method is created for a return, it may be
- associated with a claim or a swap that the return is part of.
-type: object
-required:
- - cart_id
- - claim_order_id
- - data
- - id
- - order_id
- - price
- - return_id
- - shipping_option_id
- - swap_id
-properties:
- id:
- description: The shipping method's ID
- type: string
- example: sm_01F0YET7DR2E7CYVSDHM593QG2
- shipping_option_id:
- description: The ID of the Shipping Option that the Shipping Method is built from.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- order_id:
- description: The ID of the order that the shipping method is used in.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the shipping method is used in.
- x-expandable: order
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the shipping method is used in.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the shipping method is used in.
- x-expandable: claim_order
- nullable: true
- type: object
- cart_id:
- description: The ID of the cart that the shipping method is used in.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the shipping method is used in.
- x-expandable: cart
- nullable: true
- type: object
- swap_id:
- description: The ID of the swap that the shipping method is used in.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the shipping method is used in.
- x-expandable: swap
- nullable: true
- type: object
- return_id:
- description: The ID of the return that the shipping method is used in.
- nullable: true
- type: string
- example: null
- return_order:
- description: The details of the return that the shipping method is used in.
- x-expandable: return_order
- nullable: true
- type: object
- shipping_option:
- description: The details of the shipping option the method was created from.
- x-expandable: shipping_option
- nullable: true
- $ref: ./ShippingOption.yaml
- tax_lines:
- description: The details of the tax lines applied on the shipping method.
- type: array
- x-expandable: tax_lines
- items:
- $ref: ./ShippingMethodTaxLine.yaml
- price:
- description: >-
- The amount to charge for the Shipping Method. The currency of the price is
- defined by the Region that the Order that the Shipping Method belongs to
- is a part of.
- type: integer
- example: 200
- data:
- description: >-
- Additional data that the Fulfillment Provider needs to fulfill the
- shipment. This is used in combination with the Shipping Options data, and
- may contain information such as a drop point id.
- type: object
- example: {}
- includes_tax:
- description: Whether the shipping method price include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- subtotal:
- description: The subtotal of the shipping
- type: integer
- example: 8000
- total:
- description: The total amount of the shipping
- type: integer
- example: 8200
- tax_total:
- description: The total of tax
- type: integer
- example: 0
diff --git a/www/apps/api-reference/specs/store/components/schemas/ShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/ShippingMethodTaxLine.yaml
deleted file mode 100644
index 892b8c06e0..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ShippingMethodTaxLine.yaml
+++ /dev/null
@@ -1,59 +0,0 @@
-title: Shipping Method Tax Line
-description: >-
- A Shipping Method Tax Line represents the taxes applied on a shipping method
- in a cart.
-type: object
-required:
- - code
- - created_at
- - id
- - shipping_method_id
- - metadata
- - name
- - rate
- - updated_at
-properties:
- id:
- description: The line item tax line's ID
- type: string
- example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- shipping_method_id:
- description: The ID of the line item
- type: string
- example: sm_01F0YET7DR2E7CYVSDHM593QG2
- shipping_method:
- description: The details of the associated shipping method.
- x-expandable: shipping_method
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/ShippingOption.yaml
deleted file mode 100644
index fbc4d8ed41..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ShippingOption.yaml
+++ /dev/null
@@ -1,137 +0,0 @@
-title: Shipping Option
-description: >-
- A Shipping Option represents a way in which an Order or Return can be shipped.
- Shipping Options have an associated Fulfillment Provider that will be used
- when the fulfillment of an Order is initiated. Shipping Options themselves
- cannot be added to Carts, but serve as a template for Shipping Methods. This
- distinction makes it possible to customize individual Shipping Methods with
- additional information.
-type: object
-required:
- - admin_only
- - amount
- - created_at
- - data
- - deleted_at
- - id
- - is_return
- - metadata
- - name
- - price_type
- - profile_id
- - provider_id
- - region_id
- - updated_at
-properties:
- id:
- description: The shipping option's ID
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- name:
- description: >-
- The name given to the Shipping Option - this may be displayed to the
- Customer.
- type: string
- example: PostFake Standard
- region_id:
- description: The ID of the region this shipping option can be used in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this shipping option can be used in.
- x-expandable: region
- nullable: true
- type: object
- profile_id:
- description: The ID of the Shipping Profile that the shipping option belongs to.
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- profile:
- description: The details of the shipping profile that the shipping option belongs to.
- x-expandable: profile
- nullable: true
- $ref: ./ShippingProfile.yaml
- provider_id:
- description: >-
- The ID of the fulfillment provider that will be used to later to process
- the shipping method created from this shipping option and its
- fulfillments.
- type: string
- example: manual
- provider:
- description: >-
- The details of the fulfillment provider that will be used to later to
- process the shipping method created from this shipping option and its
- fulfillments.
- x-expandable: provider
- nullable: true
- $ref: ./FulfillmentProvider.yaml
- price_type:
- description: >-
- The type of pricing calculation that is used when creatin Shipping Methods
- from the Shipping Option. Can be `flat_rate` for fixed prices or
- `calculated` if the Fulfillment Provider can provide price calulations.
- type: string
- enum:
- - flat_rate
- - calculated
- example: flat_rate
- amount:
- description: >-
- The amount to charge for shipping when the Shipping Option price type is
- `flat_rate`.
- nullable: true
- type: integer
- example: 200
- is_return:
- description: Flag to indicate if the Shipping Option can be used for Return shipments.
- type: boolean
- default: false
- admin_only:
- description: >-
- Flag to indicate if the Shipping Option usage is restricted to admin
- users.
- type: boolean
- default: false
- requirements:
- description: >-
- The details of the requirements that must be satisfied for the Shipping
- Option to be available for usage in a Cart.
- type: array
- x-expandable: requirements
- items:
- $ref: ./ShippingOptionRequirement.yaml
- data:
- description: >-
- The data needed for the Fulfillment Provider to identify the Shipping
- Option.
- type: object
- example: {}
- includes_tax:
- description: Whether the shipping option price include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ShippingOptionRequirement.yaml b/www/apps/api-reference/specs/store/components/schemas/ShippingOptionRequirement.yaml
deleted file mode 100644
index 26764f96d0..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ShippingOptionRequirement.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Shipping Option Requirement
-description: >-
- A shipping option requirement defines conditions that a Cart must satisfy for
- the Shipping Option to be available for usage in the Cart.
-type: object
-required:
- - amount
- - deleted_at
- - id
- - shipping_option_id
- - type
-properties:
- id:
- description: The shipping option requirement's ID
- type: string
- example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
- shipping_option_id:
- description: The ID of the shipping option that the requirements belong to.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the shipping option that the requirements belong to.
- x-expandable: shipping_option
- nullable: true
- type: object
- type:
- description: >-
- The type of the requirement, this defines how the value will be compared
- to the Cart's total. `min_subtotal` requirements define the minimum
- subtotal that is needed for the Shipping Option to be available, while the
- `max_subtotal` defines the maximum subtotal that the Cart can have for the
- Shipping Option to be available.
- type: string
- enum:
- - min_subtotal
- - max_subtotal
- example: min_subtotal
- amount:
- description: The amount to compare the Cart subtotal to.
- type: integer
- example: 100
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/ShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/ShippingProfile.yaml
deleted file mode 100644
index 58c9ef4558..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ShippingProfile.yaml
+++ /dev/null
@@ -1,76 +0,0 @@
-title: Shipping Profile
-description: >-
- A Shipping Profile has a set of defined Shipping Options that can be used to
- fulfill a given set of Products. For example, gift cards are shipped
- differently than physical products, so a shipping profile with the type
- `gift_card` groups together the shipping options that can only be used for
- gift cards.
-type: object
-required:
- - created_at
- - deleted_at
- - id
- - metadata
- - name
- - type
- - updated_at
-properties:
- id:
- description: The shipping profile's ID
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- name:
- description: >-
- The name given to the Shipping profile - this may be displayed to the
- Customer.
- type: string
- example: Default Shipping Profile
- type:
- description: >-
- The type of the Shipping Profile, may be `default`, `gift_card` or
- `custom`.
- type: string
- enum:
- - default
- - gift_card
- - custom
- example: default
- products:
- description: >-
- The details of the products that the Shipping Profile defines Shipping
- Options for. Available if the relation `products` is expanded.
- type: array
- x-expandable: products
- items:
- type: object
- shipping_options:
- description: >-
- The details of the shipping options that can be used to create shipping
- methods for the Products in the Shipping Profile.
- type: array
- x-expandable: shipping_options
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/ShippingTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/ShippingTaxRate.yaml
deleted file mode 100644
index c7b36795be..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/ShippingTaxRate.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-title: Shipping Tax Rate
-description: This represents the tax rates applied on a shipping option.
-type: object
-required:
- - created_at
- - metadata
- - rate_id
- - shipping_option_id
- - updated_at
-properties:
- shipping_option_id:
- description: The ID of the shipping option.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the shipping option.
- x-expandable: shipping_option
- nullable: true
- $ref: ./ShippingOption.yaml
- rate_id:
- description: The ID of the associated tax rate.
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the associated tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: ./TaxRate.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/StagedJob.yaml b/www/apps/api-reference/specs/store/components/schemas/StagedJob.yaml
deleted file mode 100644
index adc7c6beab..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StagedJob.yaml
+++ /dev/null
@@ -1,25 +0,0 @@
-title: Staged Job
-description: A staged job resource
-type: object
-required:
- - data
- - event_name
- - id
- - options
-properties:
- id:
- description: The staged job's ID
- type: string
- example: job_01F0YET7BZTARY9MKN1SJ7AAXF
- event_name:
- description: The name of the event
- type: string
- example: order.placed
- data:
- description: Data necessary for the job
- type: object
- example: {}
- option:
- description: The staged job's option
- type: object
- example: {}
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/StockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/StockLocationAddress.yaml
rename to www/apps/api-reference/specs/store/components/schemas/StockLocationAddress.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StockLocationAddressDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationAddressDTO.yaml
deleted file mode 100644
index fa00e2353d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StockLocationAddressDTO.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-title: Stock Location Address
-description: Represents a Stock Location Address
-type: object
-required:
- - address_1
- - country_code
- - created_at
- - updated_at
-properties:
- id:
- type: string
- description: The stock location address' ID
- example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42
- address_1:
- type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
- address_2:
- type: string
- description: Stock location address' complement
- example: apartment 4432
- company:
- type: string
- description: Stock location company' name
- example: Medusa
- city:
- type: string
- description: Stock location address' city
- example: Mexico city
- country_code:
- type: string
- description: Stock location address' country
- example: MX
- phone:
- type: string
- description: Stock location address' phone number
- example: +1 555 61646
- postal_code:
- type: string
- description: Stock location address' postal code
- example: HD3-1G8
- province:
- type: string
- description: Stock location address' province
- example: Sinaloa
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs/store/components/schemas/StockLocationAddressInput.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationAddressInput.yaml
deleted file mode 100644
index 700d86deb8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StockLocationAddressInput.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-title: Stock Location Address Input
-description: Represents a Stock Location Address Input
-type: object
-required:
- - address_1
- - country_code
-properties:
- address_1:
- type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
- address_2:
- type: string
- description: Stock location address' complement
- example: apartment 4432
- city:
- type: string
- description: Stock location address' city
- example: Mexico city
- country_code:
- type: string
- description: Stock location address' country
- example: MX
- phone:
- type: string
- description: Stock location address' phone number
- example: +1 555 61646
- postal_code:
- type: string
- description: Stock location address' postal code
- example: HD3-1G8
- province:
- type: string
- description: Stock location address' province
- example: Sinaloa
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs/store/components/schemas/StockLocationDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationDTO.yaml
deleted file mode 100644
index e4233fd30d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StockLocationDTO.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-title: Stock Location
-description: Represents a Stock Location
-type: object
-required:
- - id
- - name
- - address_id
- - created_at
- - updated_at
-properties:
- id:
- type: string
- description: The stock location's ID
- example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42
- address_id:
- type: string
- description: Stock location address' ID
- example: laddr_05B2ZE853Y6FTXWPW85NJ81A44
- name:
- type: string
- description: The name of the stock location
- example: Main Warehouse
- address:
- description: The Address of the Stock Location
- allOf:
- - $ref: ./StockLocationAddressDTO.yaml
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
diff --git a/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml b/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml
deleted file mode 100644
index 993fad1ca8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StockLocationExpandedDTO.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-allOf:
- - $ref: ./StockLocationDTO.yaml
- - type: object
- properties:
- sales_channels:
- description: The associated sales channels.
- $ref: ./SalesChannel.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/Store.yaml b/www/apps/api-reference/specs/store/components/schemas/Store.yaml
deleted file mode 100644
index e1331293bc..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Store.yaml
+++ /dev/null
@@ -1,98 +0,0 @@
-title: Store
-description: >-
- A store holds the main settings of the commerce shop. By default, only one
- store is created and used within the Medusa backend. It holds settings related
- to the name of the store, available currencies, and more.
-type: object
-required:
- - created_at
- - default_currency_code
- - default_location_id
- - id
- - invite_link_template
- - metadata
- - name
- - payment_link_template
- - swap_link_template
- - updated_at
-properties:
- id:
- description: The store's ID
- type: string
- example: store_01G1G5V21KADXNGH29BJMAJ4B4
- name:
- description: The name of the Store - this may be displayed to the Customer.
- type: string
- example: Medusa Store
- default: Medusa Store
- default_currency_code:
- description: The three character currency code that is the default of the store.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- default_currency:
- description: The details of the store's default currency.
- x-expandable: default_currency
- default: usd
- nullable: true
- $ref: ./Currency.yaml
- currencies:
- description: The details of the enabled currencies in the store.
- type: array
- x-expandable: currencies
- items:
- $ref: ./Currency.yaml
- swap_link_template:
- description: >-
- A template to generate Swap links from. Use {{cart_id}} to include the
- Swap's `cart_id` in the link.
- nullable: true
- type: string
- example: null
- payment_link_template:
- description: >-
- A template to generate Payment links from. Use {{cart_id}} to include the
- payment's `cart_id` in the link.
- nullable: true
- type: string
- example: null
- invite_link_template:
- description: A template to generate Invite links from
- nullable: true
- type: string
- example: null
- default_location_id:
- description: The location ID the store is associated with.
- nullable: true
- type: string
- example: null
- default_sales_channel_id:
- description: The ID of the store's default sales channel.
- nullable: true
- type: string
- example: null
- default_sales_channel:
- description: The details of the store's default sales channel.
- x-expandable: default_sales_channel
- nullable: true
- $ref: ./SalesChannel.yaml
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml
deleted file mode 100644
index a07910fbbc..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreAuthRes.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: The customer's details.
-x-expanded-relations:
- field: customer
- relations:
- - orders
- - orders.items
- - shipping_addresses
-required:
- - customer
-properties:
- customer:
- description: Customer's details.
- $ref: ./Customer.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml
deleted file mode 100644
index f234f6150f..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreBearerAuthRes.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-type: object
-description: The access token details.
-properties:
- access_token:
- description: Access token that can be used to send authenticated requests.
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingOptionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingOptionsListRes.yaml
deleted file mode 100644
index 3e5c1e0aa4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingOptionsListRes.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-x-expanded-relations:
- field: shipping_options
- implicit:
- - profile
- - requirements
-required:
- - shipping_options
-properties:
- shipping_options:
- type: array
- description: An array of shipping options details.
- items:
- $ref: ./PricedShippingOption.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml
deleted file mode 100644
index e81dfd2e6e..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCartsRes.yaml
+++ /dev/null
@@ -1,64 +0,0 @@
-type: object
-description: The cart's details.
-x-expanded-relations:
- field: cart
- relations:
- - billing_address
- - discounts
- - discounts.rule
- - gift_cards
- - items
- - items.adjustments
- - items.variant
- - payment
- - payment_sessions
- - region
- - region.countries
- - region.payment_providers
- - shipping_address
- - shipping_methods
- eager:
- - region.fulfillment_providers
- - region.payment_providers
- - shipping_methods.shipping_option
- implicit:
- - items
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - items.tax_lines
- - items.adjustments
- - gift_cards
- - discounts
- - discounts.rule
- - shipping_methods
- - shipping_methods.tax_lines
- - shipping_address
- - region
- - region.tax_rates
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - item_tax_total
- - refundable_amount
- - refunded_total
- - shipping_tax_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
-required:
- - cart
-properties:
- cart:
- description: Cart details.
- $ref: ./Cart.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml
deleted file mode 100644
index 6368865422..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsListRes.yaml
+++ /dev/null
@@ -1,24 +0,0 @@
-type: object
-description: The list of product collections with pagination fields.
-required:
- - collections
- - count
- - offset
- - limit
-properties:
- collections:
- type: array
- description: An array of product collections details
- items:
- $ref: ./ProductCollection.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of product collections skipped when retrieving the product
- collections.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml
deleted file mode 100644
index 484b75525d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the product collection.
-required:
- - collection
-properties:
- collection:
- description: Product collection details.
- $ref: ./ProductCollection.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml
deleted file mode 100644
index 6071a8d0e0..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCompleteCartRes.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-type: object
-description: >-
- If the cart is completed successfully, this will have the created order or the
- swap's details, based on the cart's type. Otherwise, it'll be the cart's
- details.
-required:
- - type
- - data
-properties:
- type:
- type: string
- description: >-
- The type of the data property. If the cart completion fails, type will be
- `cart` and the data object will be the cart's details. If the cart
- completion is successful and the cart is used for checkout, type will be
- `order` and the data object will be the order's details. If the cart
- completion is successful and the cart is used for swap creation, type will
- be `swap` and the data object will be the swap's details.
- enum:
- - order
- - cart
- - swap
- data:
- type: object
- description: The data of the result object. Its type depends on the type field.
- oneOf:
- - type: object
- allOf:
- - description: >-
- Cart was successfully authorized and order was placed
- successfully.
- - $ref: ./Order.yaml
- - type: object
- allOf:
- - description: Cart was successfully authorized but requires further actions.
- - $ref: ./Cart.yaml
- - type: object
- allOf:
- - description: Cart was used for a swap and it has been completed successfully.
- - $ref: ./Swap.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml
deleted file mode 100644
index 3bc36a35c4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListOrdersRes.yaml
+++ /dev/null
@@ -1,104 +0,0 @@
-type: object
-description: The list of the customer's orders with pagination fields.
-x-expanded-relations:
- field: orders
- relations:
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.tracking_links
- - items
- - items.variant
- - payments
- - region
- - shipping_address
- - shipping_methods
- eager:
- - region.fulfillment_providers
- - region.payment_providers
- - shipping_methods.shipping_option
- implicit:
- - claims
- - claims.additional_items
- - claims.additional_items.adjustments
- - claims.additional_items.refundable
- - claims.additional_items.tax_lines
- - customer
- - discounts
- - discounts.rule
- - gift_card_transactions
- - gift_card_transactions.gift_card
- - gift_cards
- - items
- - items.adjustments
- - items.refundable
- - items.tax_lines
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - refunds
- - region
- - shipping_address
- - shipping_methods
- - shipping_methods.tax_lines
- - swaps
- - swaps.additional_items
- - swaps.additional_items.adjustments
- - swaps.additional_items.refundable
- - swaps.additional_items.tax_lines
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - paid_total
- - refundable_amount
- - refunded_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - claims.additional_items.discount_total
- - claims.additional_items.gift_card_total
- - claims.additional_items.original_tax_total
- - claims.additional_items.original_total
- - claims.additional_items.refundable
- - claims.additional_items.subtotal
- - claims.additional_items.tax_total
- - claims.additional_items.total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- - swaps.additional_items.discount_total
- - swaps.additional_items.gift_card_total
- - swaps.additional_items.original_tax_total
- - swaps.additional_items.original_total
- - swaps.additional_items.refundable
- - swaps.additional_items.subtotal
- - swaps.additional_items.tax_total
- - swaps.additional_items.total
-required:
- - orders
- - count
- - offset
- - limit
-properties:
- orders:
- type: array
- description: An array of orders details.
- items:
- $ref: ./Order.yaml
- count:
- description: The total number of items available
- type: integer
- offset:
- description: The number of orders skipped when retrieving the orders.
- type: integer
- limit:
- description: The number of items per page
- type: integer
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml
deleted file mode 100644
index 18dde4fd55..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersListPaymentMethodsRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The payment method's details.
-required:
- - payment_methods
-properties:
- payment_methods:
- type: array
- description: The details of the saved payment methods.
- items:
- type: object
- required:
- - provider_id
- - data
- properties:
- provider_id:
- description: The ID of the Payment Provider where the payment method is saved.
- type: string
- data:
- description: >-
- The data needed for the Payment Provider to use the saved payment
- method.
- type: object
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml
deleted file mode 100644
index 8c488986d3..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The customer's details.
-x-expanded-relations:
- field: customer
- relations:
- - billing_address
- - shipping_addresses
-required:
- - customer
-properties:
- customer:
- description: Customer details.
- $ref: ./Customer.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersResetPasswordRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomersResetPasswordRes.yaml
deleted file mode 100644
index f732f2eea4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomersResetPasswordRes.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - customer
-properties:
- customer:
- description: Customer details.
- $ref: ./Customer.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml
deleted file mode 100644
index 5284fceda8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreGetAuthEmailRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: Details on whether the email exists.
-required:
- - exists
-properties:
- exists:
- description: Whether email exists or not.
- type: boolean
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml
deleted file mode 100644
index 65073b08a6..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesCategoryRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The product category's details.
-x-expanded-relations:
- field: product_category
- relations:
- - category_children
- - parent_category
-required:
- - product_category
-properties:
- product_category:
- description: Product category details.
- $ref: ./ProductCategory.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml
deleted file mode 100644
index d48f936a44..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreGetProductCategoriesRes.yaml
+++ /dev/null
@@ -1,29 +0,0 @@
-type: object
-description: The list of product categories with pagination fields.
-x-expanded-relations:
- field: product_categories
- relations:
- - category_children
- - parent_category
-required:
- - product_categories
- - count
- - offset
- - limit
-properties:
- product_categories:
- type: array
- description: An array of product categories details.
- items:
- $ref: ./ProductCategory.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: >-
- The number of product categories skipped when retrieving the product
- categories.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml
deleted file mode 100644
index e6b9ca7155..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreGiftCardsRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-description: The gift card's details.
-type: object
-required:
- - gift_card
-properties:
- gift_card:
- description: Gift card details.
- $ref: ./GiftCard.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml
deleted file mode 100644
index f979dc1cc6..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderEditsRes.yaml
+++ /dev/null
@@ -1,43 +0,0 @@
-type: object
-description: The order edit's details.
-x-expanded-relations:
- field: order_edit
- relations:
- - changes
- - changes.line_item
- - changes.line_item.variant
- - changes.original_line_item
- - changes.original_line_item.variant
- - items
- - items.adjustments
- - items.tax_lines
- - items.variant
- - payment_collection
- implicit:
- - items
- - items.tax_lines
- - items.adjustments
- - items.variant
- totals:
- - difference_due
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
-required:
- - order_edit
-properties:
- order_edit:
- description: Order edit details.
- $ref: ./OrderEdit.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml
deleted file mode 100644
index df86572f62..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreOrdersRes.yaml
+++ /dev/null
@@ -1,89 +0,0 @@
-type: object
-description: The order's details.
-required:
- - order
-x-expanded-relations:
- field: order
- relations:
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.tracking_links
- - items
- - items.variant
- - payments
- - region
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
- - region.fulfillment_providers
- - region.payment_providers
- - shipping_methods.shipping_option
- implicit:
- - claims
- - claims.additional_items
- - claims.additional_items.adjustments
- - claims.additional_items.refundable
- - claims.additional_items.tax_lines
- - discounts
- - discounts.rule
- - gift_card_transactions
- - gift_card_transactions.gift_card
- - gift_cards
- - items
- - items.adjustments
- - items.refundable
- - items.tax_lines
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - refunds
- - region
- - shipping_methods
- - shipping_methods.tax_lines
- - swaps
- - swaps.additional_items
- - swaps.additional_items.adjustments
- - swaps.additional_items.refundable
- - swaps.additional_items.tax_lines
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - paid_total
- - refundable_amount
- - refunded_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - claims.additional_items.discount_total
- - claims.additional_items.gift_card_total
- - claims.additional_items.original_tax_total
- - claims.additional_items.original_total
- - claims.additional_items.refundable
- - claims.additional_items.subtotal
- - claims.additional_items.tax_total
- - claims.additional_items.total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- - swaps.additional_items.discount_total
- - swaps.additional_items.gift_card_total
- - swaps.additional_items.original_tax_total
- - swaps.additional_items.original_total
- - swaps.additional_items.refundable
- - swaps.additional_items.subtotal
- - swaps.additional_items.tax_total
- - swaps.additional_items.total
-properties:
- order:
- description: Order details.
- $ref: ./Order.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml
deleted file mode 100644
index 6355462bdf..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionSessionsReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the payment session to manage.
-required:
- - provider_id
-properties:
- provider_id:
- type: string
- description: The ID of the Payment Provider.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml
deleted file mode 100644
index d8184c614c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsRes.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The payment collection's details.
-x-expanded-relations:
- field: payment_collection
- relations:
- - payment_sessions
- - region
- eager:
- - region.fulfillment_providers
- - region.payment_providers
-required:
- - payment_collection
-properties:
- payment_collection:
- description: Payment collection's details.
- $ref: ./PaymentCollection.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml
deleted file mode 100644
index 9eef53e303..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionsSessionRes.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the payment session.
-required:
- - payment_session
-properties:
- payment_session:
- description: Payment session's details.
- $ref: ./PaymentSession.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostAuthReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostAuthReq.yaml
deleted file mode 100644
index 6c547a53ba..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostAuthReq.yaml
+++ /dev/null
@@ -1,11 +0,0 @@
-type: object
-required:
- - email
- - password
-properties:
- email:
- type: string
- description: The Customer's email.
- password:
- type: string
- description: The Customer's password.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml
deleted file mode 100644
index d362a3c156..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartReq.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-type: object
-description: The details of the cart to be created.
-properties:
- region_id:
- type: string
- description: >-
- The ID of the Region to create the Cart in. Setting the cart's region can
- affect the pricing of the items in the cart as well as the used currency.
- If this parameter is not provided, the first region in the store is used
- by default.
- sales_channel_id:
- type: string
- description: >-
- The ID of the Sales channel to create the Cart in. The cart's sales
- channel affects which products can be added to the cart. If a product does
- not exist in the cart's sales channel, it cannot be added to the cart. If
- you add a publishable API key in the header of this request and specify a
- sales channel ID, the specified sales channel must be within the scope of
- the publishable API key's resources. If you add a publishable API key in
- the header of this request, you don't specify a sales channel ID, and the
- publishable API key is associated with one sales channel, that sales
- channel will be attached to the cart. If no sales channel is passed and no
- publishable API key header is passed or the publishable API key isn't
- associated with any sales channel, the cart will not be associated with
- any sales channel.
- country_code:
- type: string
- description: >-
- The two character ISO country code to create the Cart in. Setting this
- parameter will set the country code of the shipping address.
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- items:
- description: An array of product variants to generate line items from.
- type: array
- items:
- type: object
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- description: The ID of the Product Variant.
- type: string
- quantity:
- description: The quantity to add into the cart.
- type: integer
- context:
- description: >-
- An object to provide context to the Cart. The `context` field is
- automatically populated with `ip` and `user_agent`
- type: object
- example:
- ip: '::1'
- user_agent: Chrome
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml
deleted file mode 100644
index 811b1f8f10..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsItemReq.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The details to update of the line item.
-required:
- - quantity
-properties:
- quantity:
- type: number
- description: The quantity of the line item in the cart.
- metadata:
- type: object
- description: >-
- An optional key-value map with additional details about the Line Item. If
- omitted, the metadata will remain unchanged."
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml
deleted file mode 100644
index 4cb9dc35e8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartLineItemsReq.yaml
+++ /dev/null
@@ -1,19 +0,0 @@
-type: object
-description: The details of the line item to create.
-required:
- - variant_id
- - quantity
-properties:
- variant_id:
- type: string
- description: The id of the Product Variant to generate the Line Item from.
- quantity:
- type: number
- description: The quantity of the Product Variant to add to the Line Item.
- metadata:
- type: object
- description: An optional key-value map with additional details about the Line Item.
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml
deleted file mode 100644
index d8874ca7d0..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-description: The details of the payment session to set.
-required:
- - provider_id
-properties:
- provider_id:
- type: string
- description: The ID of the Payment Provider.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionUpdateReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionUpdateReq.yaml
deleted file mode 100644
index bd4d70742b..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartPaymentSessionUpdateReq.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - data
-properties:
- data:
- type: object
- description: The data to update the payment session with.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml
deleted file mode 100644
index 316c1a1aaf..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartReq.yaml
+++ /dev/null
@@ -1,77 +0,0 @@
-type: object
-description: The details to update of the cart.
-properties:
- region_id:
- type: string
- description: >-
- The ID of the Region to create the Cart in. Setting the cart's region can
- affect the pricing of the items in the cart as well as the used currency.
- country_code:
- type: string
- description: >-
- The 2 character ISO country code to create the Cart in. Setting this
- parameter will set the country code of the shipping address.
- externalDocs:
- url: >-
- https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- email:
- type: string
- description: An email to be used on the Cart.
- format: email
- sales_channel_id:
- type: string
- description: >-
- The ID of the Sales channel to create the Cart in. The cart's sales
- channel affects which products can be added to the cart. If a product does
- not exist in the cart's sales channel, it cannot be added to the cart. If
- you add a publishable API key in the header of this request and specify a
- sales channel ID, the specified sales channel must be within the scope of
- the publishable API key's resources.
- billing_address:
- description: The Address to be used for billing purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- description: A full billing address object.
- - type: string
- description: The billing address ID
- shipping_address:
- description: The Address to be used for shipping purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- description: A full shipping address object.
- - type: string
- description: The shipping address ID
- gift_cards:
- description: An array of Gift Card codes to add to the Cart.
- type: array
- items:
- type: object
- required:
- - code
- properties:
- code:
- description: The code of a gift card.
- type: string
- discounts:
- description: An array of Discount codes to add to the Cart.
- type: array
- items:
- type: object
- required:
- - code
- properties:
- code:
- description: The code of the discount.
- type: string
- customer_id:
- description: The ID of the Customer to associate the Cart with.
- type: string
- context:
- description: >-
- An object to provide context to the Cart. The `context` field is
- automatically populated with `ip` and `user_agent`
- type: object
- example:
- ip: '::1'
- user_agent: Chrome
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml
deleted file mode 100644
index 7d9a0fe839..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartShippingMethodReq.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: The details of the shipping method to add to the cart.
-required:
- - option_id
-properties:
- option_id:
- type: string
- description: ID of the shipping option to create the method from.
- data:
- type: object
- description: >-
- Used to hold any data that the shipping method may need to process the
- fulfillment of the order. This depends on the fulfillment provider you're
- using.
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/StorePostCartsCartTaxesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartTaxesReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/StorePostCartsCartTaxesReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/StorePostCartsCartTaxesReq.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml
deleted file mode 100644
index 8e4c9cd432..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details necessary to grant order access.
-required:
- - token
-properties:
- token:
- description: >-
- The claim token generated by previous request to the Claim Order API
- Route.
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAddressesAddressReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAddressesAddressReq.yaml
deleted file mode 100644
index 2974d52c0a..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAddressesAddressReq.yaml
+++ /dev/null
@@ -1,2 +0,0 @@
-anyOf:
- - $ref: ./AddressPayload.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAddressesReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAddressesReq.yaml
deleted file mode 100644
index 5e31c8f41c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerAddressesReq.yaml
+++ /dev/null
@@ -1,7 +0,0 @@
-type: object
-required:
- - address
-properties:
- address:
- description: The Address to add to the Customer's saved addresses.
- $ref: ./AddressCreatePayload.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml
deleted file mode 100644
index e614f770e2..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the orders to claim.
-required:
- - order_ids
-properties:
- order_ids:
- description: The ID of the orders to claim
- type: array
- items:
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml
deleted file mode 100644
index da738333c3..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml
+++ /dev/null
@@ -1,8 +0,0 @@
-type: object
-required:
- - email
-properties:
- email:
- description: The customer's email.
- type: string
- format: email
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml
deleted file mode 100644
index 5e17043272..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersCustomerReq.yaml
+++ /dev/null
@@ -1,32 +0,0 @@
-type: object
-description: The details to update of the customer.
-properties:
- first_name:
- description: The customer's first name.
- type: string
- last_name:
- description: The customer's last name.
- type: string
- billing_address:
- description: The address to be used for billing purposes.
- anyOf:
- - $ref: ./AddressPayload.yaml
- description: The full billing address object
- - type: string
- description: The ID of an existing billing address
- password:
- description: The customer's password.
- type: string
- phone:
- description: The customer's phone number.
- type: string
- email:
- description: The customer's email.
- type: string
- metadata:
- description: Additional custom data about the customer.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml
deleted file mode 100644
index 2ecd1312aa..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersReq.yaml
+++ /dev/null
@@ -1,25 +0,0 @@
-type: object
-description: The details of the customer to create.
-required:
- - first_name
- - last_name
- - email
- - password
-properties:
- first_name:
- description: The customer's first name.
- type: string
- last_name:
- description: The customer's last name.
- type: string
- email:
- description: The customer's email.
- type: string
- format: email
- password:
- description: The customer's password.
- type: string
- format: password
- phone:
- description: The customer's phone number.
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersResetPasswordReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersResetPasswordReq.yaml
deleted file mode 100644
index 36c3084296..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostCustomersResetPasswordReq.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-required:
- - email
- - password
- - token
-properties:
- email:
- description: The customer's email.
- type: string
- format: email
- password:
- description: The customer's password.
- type: string
- format: password
- token:
- description: The reset password token
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml
deleted file mode 100644
index 1ffe6e5eaf..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostOrderEditsOrderEditDecline.yaml
+++ /dev/null
@@ -1,6 +0,0 @@
-type: object
-description: The details of the order edit's decline.
-properties:
- declined_reason:
- type: string
- description: The reason for declining the Order Edit.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml
deleted file mode 100644
index 1b8dcea0f5..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml
+++ /dev/null
@@ -1,10 +0,0 @@
-type: object
-description: The details of the payment sessions to authorize.
-required:
- - session_ids
-properties:
- session_ids:
- description: List of Payment Session IDs to authorize.
- type: array
- items:
- type: string
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml
deleted file mode 100644
index 7737b9721c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml
+++ /dev/null
@@ -1,27 +0,0 @@
-type: object
-description: The details of the payment sessions to manage.
-required:
- - sessions
-properties:
- sessions:
- description: >-
- Payment sessions related to the Payment Collection. Existing sessions that
- are not added in this array will be deleted.
- type: array
- items:
- type: object
- required:
- - provider_id
- - amount
- properties:
- provider_id:
- type: string
- description: The ID of the Payment Provider.
- amount:
- type: integer
- description: The payment amount
- session_id:
- type: string
- description: >-
- The ID of the Payment Session to be updated. If no ID is provided, a
- new payment session is created.
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
rename to www/apps/api-reference/specs/store/components/schemas/StorePostPaymentCollectionsPaymentSessionReq.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml
deleted file mode 100644
index 9a52840e99..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostReturnsReq.yaml
+++ /dev/null
@@ -1,43 +0,0 @@
-type: object
-description: The details of the return to create.
-required:
- - order_id
- - items
-properties:
- order_id:
- type: string
- description: The ID of the Order to create the return for.
- items:
- description: The items to include in the return.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the line item to return.
- type: string
- quantity:
- description: The quantity to return.
- type: integer
- reason_id:
- description: >-
- The ID of the return reason. Return reasons can be retrieved from
- the List Return Reasons API Route.
- type: string
- note:
- description: A note to add to the item returned.
- type: string
- return_shipping:
- description: >-
- The return shipping method used to return the items. If provided, a
- fulfillment is automatically created for the return.
- type: object
- required:
- - option_id
- properties:
- option_id:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostSearchReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostSearchReq.yaml
deleted file mode 100644
index 77c49f5e3a..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostSearchReq.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-properties:
- q:
- type: string
- description: The search query.
- offset:
- type: number
- description: The number of products to skip when retrieving the products.
- limit:
- type: number
- description: Limit the number of products returned.
- filter:
- description: Pass filters based on the search service.
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml
deleted file mode 100644
index f689e858cd..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostSearchRes.yaml
+++ /dev/null
@@ -1,12 +0,0 @@
-description: The list of search results.
-allOf:
- - type: object
- required:
- - hits
- properties:
- hits:
- description: >-
- Array of search results. The format of the items depends on the search
- engine installed on the Medusa backend.
- type: array
- - type: object
diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml
deleted file mode 100644
index 202bd36bdd..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StorePostSwapsReq.yaml
+++ /dev/null
@@ -1,51 +0,0 @@
-type: object
-description: The details of the swap to create.
-required:
- - order_id
- - return_items
- - additional_items
-properties:
- order_id:
- type: string
- description: The ID of the Order to create the Swap for.
- return_items:
- description: The items to include in the Return.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the order's line item to return.
- type: string
- quantity:
- description: The quantity to return.
- type: integer
- reason_id:
- description: >-
- The ID of the reason of this return. Return reasons can be retrieved
- from the List Return Reasons API Route.
- type: string
- note:
- description: The note to add to the item being swapped.
- type: string
- return_shipping_option:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- additional_items:
- description: The items to exchange the returned items with.
- type: array
- items:
- type: object
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- description: The ID of the Product Variant.
- type: string
- quantity:
- description: The quantity of the variant.
- type: integer
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml
deleted file mode 100644
index 1c6c262968..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreProductTagsListRes.yaml
+++ /dev/null
@@ -1,22 +0,0 @@
-type: object
-description: The list of product tags with pagination fields.
-required:
- - product_tags
- - count
- - offset
- - limit
-properties:
- product_tags:
- type: array
- description: An array of product tags details.
- items:
- $ref: ./ProductTag.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product tags skipped when retrieving the product tags.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductTypesListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductTypesListRes.yaml
deleted file mode 100644
index 643254d68d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreProductTypesListRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-required:
- - product_types
- - count
- - offset
- - limit
-properties:
- product_types:
- type: array
- description: An array of product types details.
- items:
- $ref: ./ProductType.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product types skipped when retrieving the product types.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml
deleted file mode 100644
index 8acc42fbd4..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreProductsListRes.yaml
+++ /dev/null
@@ -1,36 +0,0 @@
-type: object
-description: The list of products with pagination fields.
-x-expanded-relations:
- field: products
- relations:
- - collection
- - images
- - options
- - options.values
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
- totals:
- - variants.purchasable
-required:
- - products
- - count
- - offset
- - limit
-properties:
- products:
- type: array
- description: An array of products details.
- items:
- $ref: ./PricedProduct.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of products skipped when retrieving the products.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductsRes.yaml
deleted file mode 100644
index b911e26d37..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreProductsRes.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-type: object
-x-expanded-relations:
- field: product
- relations:
- - collection
- - images
- - options
- - options.values
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
- totals:
- - variants.purchasable
-required:
- - product
-properties:
- product:
- description: Product details.
- $ref: ./PricedProduct.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml
deleted file mode 100644
index 8c19a9ffc8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsListRes.yaml
+++ /dev/null
@@ -1,28 +0,0 @@
-type: object
-description: The list of regions with pagination fields.
-x-expanded-relations:
- field: regions
- relations:
- - countries
- - payment_providers
- - fulfillment_providers
- eager:
- - payment_providers
- - fulfillment_providers
-required:
- - regions
-properties:
- regions:
- type: array
- description: An array of regions details.
- items:
- $ref: ./Region.yaml
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of regions skipped when retrieving the regions.
- limit:
- type: integer
- description: The number of items per page
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml
deleted file mode 100644
index 5d89f837ee..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreRegionsRes.yaml
+++ /dev/null
@@ -1,17 +0,0 @@
-type: object
-description: The region's details.
-x-expanded-relations:
- field: region
- relations:
- - countries
- - payment_providers
- - fulfillment_providers
- eager:
- - payment_providers
- - fulfillment_providers
-required:
- - region
-properties:
- region:
- description: Region details.
- $ref: ./Region.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml
deleted file mode 100644
index a40b7de4ef..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsListRes.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-description: The list of return reasons.
-x-expanded-relations:
- field: return_reasons
- relations:
- - parent_return_reason
- - return_reason_children
-required:
- - return_reasons
-properties:
- return_reasons:
- type: array
- description: An array of return reasons details.
- items:
- $ref: ./ReturnReason.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml
deleted file mode 100644
index 74ce5c5d7d..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonsRes.yaml
+++ /dev/null
@@ -1,13 +0,0 @@
-type: object
-description: The return reason's details.
-x-expanded-relations:
- field: return_reason
- relations:
- - parent_return_reason
- - return_reason_children
-required:
- - return_reason
-properties:
- return_reason:
- description: Return reason details.
- $ref: ./ReturnReason.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml
deleted file mode 100644
index 831aa95d7c..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnsRes.yaml
+++ /dev/null
@@ -1,15 +0,0 @@
-type: object
-description: The return's details.
-x-expanded-relations:
- field: return
- relations:
- - items
- - items.reason
- eager:
- - items
-required:
- - return
-properties:
- return:
- description: Return details.
- $ref: ./Return.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml
deleted file mode 100644
index 3e9f8e6139..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionsListRes.yaml
+++ /dev/null
@@ -1,14 +0,0 @@
-type: object
-description: The list of shipping options.
-x-expanded-relations:
- field: shipping_options
- relations:
- - requirements
-required:
- - shipping_options
-properties:
- shipping_options:
- type: array
- description: An array of shipping options details.
- items:
- $ref: ./PricedShippingOption.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml
deleted file mode 100644
index 2557a02fb8..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreSwapsRes.yaml
+++ /dev/null
@@ -1,23 +0,0 @@
-type: object
-description: The swap's details.
-x-expanded-relations:
- field: swap
- relations:
- - additional_items
- - additional_items.variant
- - cart
- - fulfillments
- - order
- - payment
- - return_order
- - return_order.shipping_method
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
-required:
- - swap
-properties:
- swap:
- description: Swap details.
- $ref: ./Swap.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml
deleted file mode 100644
index 92c48a7d66..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsListRes.yaml
+++ /dev/null
@@ -1,18 +0,0 @@
-type: object
-description: The list of product variants.
-x-expanded-relations:
- field: variants
- relations:
- - prices
- - options
- - product
- totals:
- - purchasable
-required:
- - variants
-properties:
- variants:
- type: array
- description: An array of product variant descriptions.
- items:
- $ref: ./PricedVariant.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml
deleted file mode 100644
index 0263244edd..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/StoreVariantsRes.yaml
+++ /dev/null
@@ -1,16 +0,0 @@
-type: object
-description: The product variant's details.
-x-expanded-relations:
- field: variant
- relations:
- - prices
- - options
- - product
- totals:
- - purchasable
-required:
- - variant
-properties:
- variant:
- description: Product variant description.
- $ref: ./PricedVariant.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/Swap.yaml b/www/apps/api-reference/specs/store/components/schemas/Swap.yaml
deleted file mode 100644
index 7e00bf1687..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/Swap.yaml
+++ /dev/null
@@ -1,186 +0,0 @@
-title: Swap
-description: >-
- A swap can be created when a Customer wishes to exchange Products that they
- have purchased with different Products. It consists of a Return of previously
- purchased Products and a Fulfillment of new Products. It also includes
- information on any additional payment or refund required based on the
- difference between the exchanged products.
-type: object
-required:
- - allow_backorder
- - canceled_at
- - cart_id
- - confirmed_at
- - created_at
- - deleted_at
- - difference_due
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - order_id
- - payment_status
- - shipping_address_id
- - updated_at
-properties:
- id:
- description: The swap's ID
- type: string
- example: swap_01F0YET86Y9G92D3YDR9Y6V676
- fulfillment_status:
- description: The status of the Fulfillment of the Swap.
- type: string
- enum:
- - not_fulfilled
- - fulfilled
- - shipped
- - partially_shipped
- - canceled
- - requires_action
- example: not_fulfilled
- payment_status:
- description: >-
- The status of the Payment of the Swap. The payment may either refer to the
- refund of an amount or the authorization of a new amount.
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - confirmed
- - canceled
- - difference_refunded
- - partially_refunded
- - refunded
- - requires_action
- example: not_paid
- order_id:
- description: The ID of the order that the swap belongs to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the swap belongs to.
- x-expandable: order
- nullable: true
- type: object
- additional_items:
- description: >-
- The details of the new products to send to the customer, represented as
- line items.
- type: array
- x-expandable: additional_items
- items:
- $ref: ./LineItem.yaml
- return_order:
- description: >-
- The details of the return that belongs to the swap, which holds the
- details on the items being returned.
- x-expandable: return_order
- nullable: true
- type: object
- fulfillments:
- description: >-
- The details of the fulfillments that are used to send the new items to the
- customer.
- x-expandable: fulfillments
- type: array
- items:
- type: object
- payment:
- description: >-
- The details of the additional payment authorized by the customer when
- `difference_due` is positive.
- x-expandable: payment
- nullable: true
- type: object
- difference_due:
- description: >-
- The difference amount between the order’s original total and the new total
- imposed by the swap. If its value is negative, a refund must be issues to
- the customer. If it's positive, additional payment must be authorized by
- the customer. Otherwise, no payment processing is required.
- nullable: true
- type: integer
- example: 0
- shipping_address_id:
- description: >-
- The Address to send the new Line Items to - in most cases this will be the
- same as the shipping address on the Order.
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address that the new items should be sent to.
- x-expandable: shipping_address
- nullable: true
- $ref: ./Address.yaml
- shipping_methods:
- description: >-
- The details of the shipping methods used to fulfill the additional items
- purchased.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: ./ShippingMethod.yaml
- cart_id:
- description: The ID of the cart that the customer uses to complete the swap.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the customer uses to complete the swap.
- x-expandable: cart
- nullable: true
- type: object
- confirmed_at:
- description: The date with timezone at which the Swap was confirmed by the Customer.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date with timezone at which the Swap was canceled.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: If set to true, no notification will be sent related to this swap
- nullable: true
- type: boolean
- example: false
- allow_backorder:
- description: If true, swaps can be completed with items out of stock
- type: boolean
- default: false
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of the swap in case
- of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/TaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/TaxLine.yaml
deleted file mode 100644
index cbdb672a17..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/TaxLine.yaml
+++ /dev/null
@@ -1,47 +0,0 @@
-title: Tax Line
-description: A tax line represents the taxes amount applied to a line item.
-type: object
-required:
- - code
- - created_at
- - id
- - metadata
- - name
- - rate
- - updated_at
-properties:
- id:
- description: The tax line's ID
- type: string
- example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/TaxProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/TaxProvider.yaml
deleted file mode 100644
index 0abb0ed394..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/TaxProvider.yaml
+++ /dev/null
@@ -1,21 +0,0 @@
-title: Tax Provider
-description: >-
- A tax provider represents a tax service installed in the Medusa backend,
- either through a plugin or backend customizations. It holds the tax service's
- installation status.
-type: object
-required:
- - id
- - is_installed
-properties:
- id:
- description: The ID of the tax provider as given by the tax service.
- type: string
- example: manual
- is_installed:
- description: >-
- Whether the tax service is installed in the current version. If a tax
- service is no longer installed, the `is_installed` attribute is set to
- `false`.
- type: boolean
- default: true
diff --git a/www/apps/api-reference/specs/store/components/schemas/TaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/TaxRate.yaml
deleted file mode 100644
index aaf91c7e76..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/TaxRate.yaml
+++ /dev/null
@@ -1,90 +0,0 @@
-title: Tax Rate
-description: >-
- A Tax Rate can be used to define a custom rate to charge on specified
- products, product types, and shipping options within a given region.
-type: object
-required:
- - code
- - created_at
- - id
- - metadata
- - name
- - rate
- - region_id
- - updated_at
-properties:
- id:
- description: The tax rate's ID
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- rate:
- description: The numeric rate to charge
- nullable: true
- type: number
- example: 10
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- region_id:
- description: The ID of the region that the rate belongs to.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region that the rate belongs to.
- x-expandable: region
- nullable: true
- type: object
- products:
- description: The details of the products that belong to this tax rate.
- type: array
- x-expandable: products
- items:
- $ref: ./Product.yaml
- product_types:
- description: The details of the product types that belong to this tax rate.
- type: array
- x-expandable: product_types
- items:
- $ref: ./ProductType.yaml
- shipping_options:
- description: The details of the shipping options that belong to this tax rate.
- type: array
- x-expandable: shipping_options
- items:
- $ref: ./ShippingOption.yaml
- product_count:
- description: The count of products
- type: integer
- example: 10
- product_type_count:
- description: The count of product types
- type: integer
- example: 2
- shipping_option_count:
- description: The count of shipping options
- type: integer
- example: 1
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/components/schemas/TrackingLink.yaml b/www/apps/api-reference/specs/store/components/schemas/TrackingLink.yaml
deleted file mode 100644
index 2da6690dae..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/TrackingLink.yaml
+++ /dev/null
@@ -1,72 +0,0 @@
-title: Tracking Link
-description: >-
- A tracking link holds information about tracking numbers for a Fulfillment.
- Tracking Links can optionally contain a URL that can be visited to see the
- status of the shipment. Typically, the tracking link is provided from the
- third-party service integrated through the used fulfillment provider.
-type: object
-required:
- - created_at
- - deleted_at
- - fulfillment_id
- - id
- - idempotency_key
- - metadata
- - tracking_number
- - updated_at
- - url
-properties:
- id:
- description: The tracking link's ID
- type: string
- example: tlink_01G8ZH853Y6TFXWPG5EYE81X63
- url:
- description: The URL at which the status of the shipment can be tracked.
- nullable: true
- type: string
- format: uri
- tracking_number:
- description: The tracking number given by the shipping carrier.
- type: string
- format: RH370168054CN
- fulfillment_id:
- description: The ID of the fulfillment that the tracking link belongs to.
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- fulfillment:
- description: The details of the fulfillment that the tracking link belongs to.
- x-expandable: fulfillment
- nullable: true
- type: object
- idempotency_key:
- description: >-
- Randomly generated key used to continue the completion of a process in
- case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateAddress.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateApiKey.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateApiKey.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateApiKey.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateCartData.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProduct.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateProduct.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateProduct.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateProductCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProductCollection.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateProductCollection.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateProductCollection.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProductOption.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateProductOption.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateProductOption.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateProductVariant.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateProductVariant.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateProductVariant.yaml
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpdateRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateRegion.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpdateRegion.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpdateRegion.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateStockLocationInput.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateStockLocationInput.yaml
deleted file mode 100644
index 6b14b20a0e..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/UpdateStockLocationInput.yaml
+++ /dev/null
@@ -1,20 +0,0 @@
-title: Update Stock Location Input
-description: Represents the Input to update a Stock Location
-type: object
-properties:
- name:
- type: string
- description: The stock location name
- address_id:
- type: string
- description: The Stock location address ID
- address:
- description: Stock location address object
- allOf:
- - $ref: ./StockLocationAddressInput.yaml
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
diff --git a/www/apps/api-reference/specs-v2/store/components/schemas/UpsertProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/UpsertProductVariant.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/components/schemas/UpsertProductVariant.yaml
rename to www/apps/api-reference/specs/store/components/schemas/UpsertProductVariant.yaml
diff --git a/www/apps/api-reference/specs/store/components/schemas/User.yaml b/www/apps/api-reference/specs/store/components/schemas/User.yaml
deleted file mode 100644
index 33f313d896..0000000000
--- a/www/apps/api-reference/specs/store/components/schemas/User.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-title: User
-description: A User is an administrator who can manage store settings and data.
-type: object
-required:
- - api_token
- - created_at
- - deleted_at
- - email
- - first_name
- - id
- - last_name
- - metadata
- - role
- - updated_at
-properties:
- id:
- description: The user's ID
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- role:
- description: The user's role. These roles don't provide any different privileges.
- type: string
- enum:
- - admin
- - member
- - developer
- default: member
- email:
- description: The email of the User
- type: string
- format: email
- first_name:
- description: The first name of the User
- nullable: true
- type: string
- example: Levi
- last_name:
- description: The last name of the User
- nullable: true
- type: string
- example: Bogan
- api_token:
- description: An API token associated with the user.
- nullable: true
- type: string
- example: null
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: >-
- https://docs.medusajs.com/development/entities/overview#metadata-attribute
diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml
index 80315b72cf..fe076c90a1 100644
--- a/www/apps/api-reference/specs/store/openapi.full.yaml
+++ b/www/apps/api-reference/specs/store/openapi.full.yaml
@@ -1,6 +1,6 @@
openapi: 3.0.0
info:
- version: 1.0.0
+ version: 2.0.0
title: Medusa Storefront API
license:
name: MIT
@@ -9,13 +9,6 @@ servers:
- url: http://localhost:9000
- url: https://api.medusa-commerce.com
tags:
- - name: Auth
- description: |
- Authentication API Routes allow you to manage a customer's session, such as login or log out.
- You can send authenticated requests for a customer either using the Cookie header or using the JWT Token.
- externalDocs:
- description: How to implement customer profiles in your storefront
- url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
- name: Carts
description: |
A cart is a virtual shopping bag that customers can use to add items they want to purchase.
@@ -23,65 +16,16 @@ tags:
externalDocs:
description: How to implement cart functionality in your storefront
url: https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart
+ - name: Currencies
- name: Customers
description: |
A customer can register and manage their information such as addresses, orders, payment methods, and more.
externalDocs:
description: How to implement customer profiles in your storefront
url: https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
- - name: Gift Cards
- description: |
- Customers can use gift cards during checkout to deduct the gift card's balance from the checkout total.
- The Gift Card API Routes allow retrieving a gift card's details by its code. A gift card can be applied to a cart using the Carts API Routes.
- externalDocs:
- description: How to use gift cards in a storefront
- url: https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards
- - name: Orders
- description: |
- Orders are purchases made by customers, typically through a storefront.
- Orders are placed and created using the Carts API Routes. The Orders API Routes allow retrieving and claiming orders.
- externalDocs:
- description: How to retrieve order details in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details
- - name: Order Edits
- description: |
- Order edits are changes made to items in an order such as adding, updating their quantity, or deleting them. Order edits are created by the admin.
- A customer can review order edit requests created by an admin and confirm or decline them.
- externalDocs:
- description: How to handle order edits in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/handle-order-edits
- name: Payment Collections
description: |
A payment collection is useful for managing additional payments, such as for Order Edits, or installment payments.
- - name: Products
- description: |
- Products are saleable items in a store. This also includes [saleable gift cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards) in a store.
- Using these API Routes, you can filter products by categories, collections, sales channels, and more.
- externalDocs:
- description: How to show products in a storefront
- url: https://docs.medusajs.com/modules/products/storefront/show-products
- - name: Product Variants
- description: |
- Product variants are the actual salable item in your store. Each variant is a combination of the different option values available on the product.
- - name: Product Categories
- description: |
- Products can be categoriezed into categories. A product can be associated more than one category.
- Using these API Routes, you can list or retrieve a category's details and products.
- externalDocs:
- description: How to use product categories in a storefront
- url: https://docs.medusajs.com/modules/products/storefront/use-categories
- - name: Product Collections
- description: |
- A product collection is used to organize products for different purposes such as marketing or discount purposes. For example, you can create a Summer Collection.
- Using these API Routes, you can list or retrieve a collection's details and products.
- - name: Product Tags
- description: |
- Product tags are string values that can be used to filter products by.
- Products can have more than one tag, and products can share tags.
- - name: Product Types
- description: |
- Product types are string values that can be used to filter products by.
- Products can have more than one tag, and products can share types.
- name: Regions
description: |
Regions are different countries or geographical regions that the commerce store serves customers in.
@@ -89,343 +33,31 @@ tags:
externalDocs:
description: How to use regions in a storefront
url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
- - name: Returns
- description: |
- A return can be created by a customer to return items in an order.
- externalDocs:
- description: How to create a return in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/create-return
- - name: Return Reasons
- description: |
- Return reasons are key-value pairs that are used to specify why an order return is being created.
- name: Shipping Options
description: |
A shipping option is used to define the available shipping methods during checkout or when creating a return.
externalDocs:
description: Shipping Option architecture
url: https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
- - name: Swaps
- description: |
- A swap is created by a customer or an admin to exchange an item with a new one.
- Creating a swap implicitely includes creating a return for the item being exchanged.
- externalDocs:
- description: How to create a swap in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/create-swap
paths:
- /store/auth:
- get:
- operationId: GetAuth
- summary: Get Current Customer
- description: Retrieve the currently logged in Customer's details.
- x-authenticated: true
- x-codegen:
- method: getSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged
- medusa.auth.getSession()
- .then(({ customer }) => {
- console.log(customer.id);
- })
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/auth' \
- -H 'Authorization: Bearer {access_token}'
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreAuthRes'
- '400':
- $ref: '#/components/responses/400_error'
- '401':
- $ref: '#/components/responses/unauthorized'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- post:
- operationId: PostAuth
- summary: Customer Login
- description: Log a customer in and includes the Cookie session in the response header. The cookie session can be used in subsequent requests to authenticate the customer. When using Medusa's JS or Medusa React clients, the cookie is automatically attached to subsequent requests.
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StorePostAuthReq'
- x-codegen:
- method: authenticate
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.auth.authenticate({
- email: "user@example.com",
- password: "user@example.com"
- })
- .then(({ customer }) => {
- console.log(customer.id);
- })
- - lang: Shell
- label: cURL
- source: |
- curl -X POST '{backend_url}/store/auth' \
- -H 'Content-Type: application/json' \
- --data-raw '{
- "email": "user@example.com",
- "password": "supersecret"
- }'
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreAuthRes'
- '400':
- $ref: '#/components/responses/400_error'
- '401':
- $ref: '#/components/responses/incorrect_credentials'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- delete:
- operationId: DeleteAuth
- summary: Customer Log out
- description: Delete the current session for the logged in customer.
- x-authenticated: true
- x-codegen:
- method: deleteSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.auth.deleteSession()
- .then(() => {
- // customer logged out successfully
- })
- - lang: Shell
- label: cURL
- source: |
- curl -X DELETE '{backend_url}/store/auth' \
- -H 'Authorization: Bearer {access_token}'
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Auth
- responses:
- '200':
- description: OK
- '400':
- $ref: '#/components/responses/400_error'
- '401':
- $ref: '#/components/responses/unauthorized'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- /store/auth/token:
- post:
- operationId: PostToken
- summary: Customer Login (JWT)
- x-authenticated: false
- description: After a successful login, a JWT token is returned, which can be used to send authenticated requests.
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StorePostAuthReq'
- x-codegen:
- method: getToken
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.auth.getToken({
- email: 'user@example.com',
- password: 'supersecret'
- })
- .then(({ access_token }) => {
- console.log(access_token);
- })
- - lang: Shell
- label: cURL
- source: |
- curl -X POST '{backend_url}/store/auth/token' \
- -H 'Content-Type: application/json' \
- --data-raw '{
- "email": "user@example.com",
- "password": "supersecret"
- }'
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreBearerAuthRes'
- '400':
- $ref: '#/components/responses/400_error'
- '401':
- $ref: '#/components/responses/incorrect_credentials'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- /store/auth/{email}:
- get:
- operationId: GetAuthEmail
- summary: Check if Email Exists
- description: Check if there's a customer already registered with the provided email.
- parameters:
- - in: path
- name: email
- schema:
- type: string
- format: email
- required: true
- description: The email to check.
- x-codegen:
- method: exists
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.auth.exists("user@example.com")
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/auth/user@example.com'
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreGetAuthEmailRes'
- '400':
- $ref: '#/components/responses/400_error'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
/store/carts:
post:
- operationId: PostCart
- summary: Create a Cart
- description: |
- Create a Cart. Although optional, specifying the cart's region and sales channel can affect the cart's pricing and
- the products that can be added to the cart respectively. So, make sure to set those early on and change them if necessary, such as when the customer changes their region.
-
- If a customer is logged in, make sure to pass its ID or email within the cart's details so that the cart is attached to the customer.
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StorePostCartReq'
- x-codegen:
- method: create
+ operationId: PostCarts
+ summary: Create Cart
+ description: Create a cart.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.carts.create()
- .then(({ cart }) => {
- console.log(cart.id);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useCreateCart } from "medusa-react"
-
- type Props = {
- regionId: string
- }
-
- const Cart = ({ regionId }: Props) => {
- const createCart = useCreateCart()
-
- const handleCreate = () => {
- createCart.mutate({
- region_id: regionId
- // creates an empty cart
- }, {
- onSuccess: ({ cart }) => {
- console.log(cart.items)
- }
- })
- }
-
- // ...
- }
-
- export default Cart
- lang: Shell
label: cURL
- source: |
- curl -X POST '{backend_url}/store/carts'
+ source: curl -X POST '{backend_url}/store/carts'
tags:
- Carts
responses:
- '200':
- description: Successfully created a new Cart
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreCartsRes'
'400':
$ref: '#/components/responses/400_error'
+ '401':
+ $ref: '#/components/responses/unauthorized'
'404':
$ref: '#/components/responses/not_found_error'
'409':
@@ -434,76 +66,34 @@ paths:
$ref: '#/components/responses/invalid_request_error'
'500':
$ref: '#/components/responses/500_error'
+ requestBody:
+ content:
+ application/json:
+ schema: {}
/store/carts/{id}:
get:
- operationId: GetCartsCart
+ operationId: GetCartsId
summary: Get a Cart
- description: Retrieve a Cart's details. This includes recalculating its totals.
+ description: Retrieve a cart by its ID. You can expand the cart's relations or select the fields that should be returned.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The cart's ID.
required: true
- description: The ID of the Cart.
schema:
type: string
- x-codegen:
- method: retrieve
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.carts.retrieve(cartId)
- .then(({ cart }) => {
- console.log(cart.id);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useGetCart } from "medusa-react"
-
- type Props = {
- cartId: string
- }
-
- const Cart = ({ cartId }: Props) => {
- const { cart, isLoading } = useGetCart(cartId)
-
- return (
-
- )
- }
-
- export default Tags
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/product-tags'
- tags:
- - Product Tags
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreProductTagsListRes'
- '400':
- $ref: '#/components/responses/400_error'
- '401':
- $ref: '#/components/responses/unauthorized'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- /store/product-types:
- get:
- operationId: GetProductTypes
- summary: List Product Types
- description: Retrieve a list of product types. The product types can be filtered by fields such as `value` or `q`. The product types can also be sorted or paginated.
- x-authenticated: true
- parameters:
- - in: query
- name: limit
- description: Limit the number of product types returned.
- schema:
- type: integer
- default: 20
- - in: query
- name: offset
- description: The number of product types to skip when retrieving the product types.
- schema:
- type: integer
- default: 0
- - in: query
- name: order
- description: A product-type field to sort-order the retrieved product types by.
- schema:
- type: string
- - in: query
- name: discount_condition_id
- description: Filter by the ID of a discount condition. When provided, only types that the discount condition applies for will be retrieved.
- schema:
- type: string
- - in: query
- name: value
- style: form
- explode: false
- description: Filter by type values.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by IDs.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: q
- description: term to search product type's value.
- schema:
- type: string
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- x-codegen:
- method: list
- queryParams: StoreGetProductTypesParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.productTypes.list()
- .then(({ product_types }) => {
- console.log(product_types.length);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useProductTypes } from "medusa-react"
-
- function Types() {
- const {
- product_types,
- isLoading,
- } = useProductTypes()
-
- return (
-
- )
- }
-
- export default Types
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/product-types'
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Product Types
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreProductTypesListRes'
- '400':
- $ref: '#/components/responses/400_error'
- '401':
- $ref: '#/components/responses/unauthorized'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- /store/products:
- get:
- operationId: GetProducts
- summary: List Products
- description: |
- Retrieves a list of products. The products can be filtered by fields such as `id` or `q`. The products can also be sorted or paginated.
- This API Route can also be used to retrieve a product by its handle.
-
- For accurate and correct pricing of the products based on the customer's context, it's highly recommended to pass fields such as
- `region_id`, `currency_code`, and `cart_id` when available.
-
- Passing `sales_channel_id` ensures retrieving only products available in the specified sales channel.
- You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to retrieve a product by its handle
- url: https://docs.medusajs.com/modules/products/storefront/show-products#retrieve-product-by-handle
- parameters:
- - in: query
- name: q
- description: term used to search products' title, description, variant's title, variant's sku, and collection's title.
- schema:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by IDs.
- schema:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- - in: query
- name: sales_channel_id
- style: form
- explode: false
- description: Filter by sales channel IDs. When provided, only products available in the selected sales channels are retrieved. Alternatively, you can pass a publishable API key in the request header and this will have the same effect.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: collection_id
- style: form
- explode: false
- description: Filter by product collection IDs. When provided, only products that belong to the specified product collections are retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: type_id
- style: form
- explode: false
- description: Filter by product type IDs. When provided, only products that belong to the specified product types are retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: tags
- style: form
- explode: false
- description: Filter by product tag IDs. When provided, only products that belong to the specified product tags are retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: title
- description: Filter by title.
- schema:
- type: string
- - in: query
- name: description
- description: Filter by description
- schema:
- type: string
- - in: query
- name: handle
- description: Filter by handle.
- schema:
- type: string
- - in: query
- name: is_giftcard
- description: Whether to retrieve regular products or gift-card products.
- schema:
- type: boolean
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: category_id
- style: form
- explode: false
- description: Filter by product category IDs. When provided, only products that belong to the specified product categories are retrieved.
- schema:
- type: array
- x-featureFlag: product_categories
- items:
- type: string
- - in: query
- name: include_category_children
- style: form
- explode: false
- description: Whether to include child product categories when filtering using the `category_id` field.
- schema:
- type: boolean
- x-featureFlag: product_categories
- - in: query
- name: offset
- description: The number of products to skip when retrieving the products.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of products returned.
- schema:
- type: integer
- default: 100
- - in: query
- name: expand
- description: Comma-separated relations that should be expanded in the returned products.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned products.
- schema:
- type: string
- - in: query
- name: order
- description: A product field to sort-order the retrieved products by.
- schema:
- type: string
- - in: query
- name: cart_id
- description: The ID of the cart. This is useful for accurate pricing based on the cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: The ID of the region. This is useful for accurate pricing based on the selected region.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: A 3 character ISO currency code. This is useful for accurate pricing based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- x-codegen:
- method: list
- queryParams: StoreGetProductsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.products.list()
- .then(({ products, limit, offset, count }) => {
- console.log(products.length);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useProducts } from "medusa-react"
-
- const Products = () => {
- const { products, isLoading } = useProducts()
-
- return (
-
- )
- }
-
- export default Product
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/products/{id}'
- tags:
- - Products
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreProductsRes'
- '400':
- $ref: '#/components/responses/400_error'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
/store/regions:
get:
operationId: GetRegions
summary: List Regions
- description: Retrieve a list of regions. The regions can be filtered by fields such as `created_at`. The regions can also be paginated. This API Route is useful to show the customer all available regions to choose from.
- externalDocs:
- description: How to use regions in a storefront
- url: https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
- parameters:
- - in: query
- name: offset
- description: The number of regions to skip when retrieving the regions.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of regions returned.
- schema:
- type: integer
- default: 100
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- x-codegen:
- method: list
- queryParams: StoreGetRegionsParams
+ description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- medusa.regions.list()
- .then(({ regions, count, limit, offset }) => {
- console.log(regions.length);
- })
- - lang: tsx
- label: Medusa React
- source: |
- import React from "react"
- import { useRegions } from "medusa-react"
-
- const Regions = () => {
- const { regions, isLoading } = useRegions()
-
- return (
-
- )
- }
-
- export default Swap
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/swaps/{cart_id}'
- tags:
- - Swaps
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreSwapsRes'
- '400':
- $ref: '#/components/responses/400_error'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- /store/variants:
- get:
- operationId: GetVariants
- summary: Get Product Variants
- description: |
- Retrieves a list of product variants. The product variants can be filtered by fields such as `id` or `title`. The product variants can also be paginated.
-
- For accurate and correct pricing of the product variants based on the customer's context, it's highly recommended to pass fields such as
- `region_id`, `currency_code`, and `cart_id` when available.
-
- Passing `sales_channel_id` ensures retrieving only variants of products available in the specified sales channel.
- You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to pass product pricing parameters
- url: https://docs.medusajs.com/modules/products/storefront/show-products#product-pricing-parameters
- parameters:
- - in: query
- name: ids
- description: Filter by a comma-separated list of IDs. If supplied, it overrides the `id` parameter.
- schema:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by one or more IDs. If `ids` is supplied, it's overrides the value of this parameter.
- schema:
- oneOf:
- - type: string
- description: Filter by an ID.
- - type: array
- description: Filter by IDs.
- items:
- type: string
- - in: query
- name: sales_channel_id
- description: '"Filter by sales channel IDs. When provided, only products available in the selected sales channels are retrieved. Alternatively, you can pass a publishable API key in the request header and this will have the same effect."'
- schema:
- type: string
- - in: query
- name: expand
- description: Comma-separated relations that should be expanded in the returned product variants.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned product variants.
- schema:
- type: string
- - in: query
- name: offset
- description: The number of products to skip when retrieving the product variants.
- schema:
- type: number
- default: '0'
- - in: query
- name: limit
- description: Limit the number of product variants returned.
- schema:
- type: number
- default: '100'
- - in: query
- name: cart_id
- description: The ID of the cart. This is useful for accurate pricing based on the cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: The ID of the region. This is useful for accurate pricing based on the selected region.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: A 3 character ISO currency code. This is useful for accurate pricing based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- - in: query
- name: title
- style: form
- explode: false
- description: Filter by title
- schema:
- oneOf:
- - type: string
- description: a single title to filter by
- - type: array
- description: multiple titles to filter by
- items:
- type: string
- - in: query
- name: inventory_quantity
- description: Filter by available inventory quantity
- schema:
- oneOf:
- - type: number
- description: A specific number to filter by.
- - type: object
- description: Filter using less and greater than comparisons.
- properties:
- lt:
- type: number
- description: Filter by inventory quantity less than this number
- gt:
- type: number
- description: Filter by inventory quantity greater than this number
- lte:
- type: number
- description: Filter by inventory quantity less than or equal to this number
- gte:
- type: number
- description: Filter by inventory quantity greater than or equal to this number
- x-codegen:
- method: list
- queryParams: StoreGetVariantsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.product.variants.list()
- .then(({ variants }) => {
- console.log(variants.length);
- })
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/variants'
- tags:
- - Product Variants
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreVariantsListRes'
- '400':
- $ref: '#/components/responses/400_error'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
- /store/variants/{id}:
- get:
- operationId: GetVariantsVariant
- summary: Get a Product Variant
- description: |
- Retrieve a Product Variant's details. For accurate and correct pricing of the product variant based on the customer's context, it's highly recommended to pass fields such as
- `region_id`, `currency_code`, and `cart_id` when available.
-
- Passing `sales_channel_id` ensures retrieving only variants of products available in the current sales channel.
- You can alternatively use a publishable API key in the request header instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to pass product pricing parameters
- url: https://docs.medusajs.com/modules/products/storefront/show-products#product-pricing-parameters
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Product Variant.
- schema:
- type: string
- - in: query
- name: sales_channel_id
- description: The ID of the sales channel the customer is viewing the product variant from.
- schema:
- type: string
- - in: query
- name: cart_id
- description: The ID of the cart. This is useful for accurate pricing based on the cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: The ID of the region. This is useful for accurate pricing based on the selected region.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: A 3 character ISO currency code. This is useful for accurate pricing based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- x-codegen:
- method: retrieve
- queryParams: StoreGetVariantsVariantParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source: |
- import Medusa from "@medusajs/medusa-js"
- const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
- // must be previously logged in or use api token
- medusa.product.variants.retrieve(productVariantId)
- .then(({ variant }) => {
- console.log(variant.id);
- })
- - lang: Shell
- label: cURL
- source: |
- curl '{backend_url}/store/variants/{id}'
- tags:
- - Product Variants
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/StoreVariantsRes'
- '400':
- $ref: '#/components/responses/400_error'
- '404':
- $ref: '#/components/responses/not_found_error'
- '409':
- $ref: '#/components/responses/invalid_state_error'
- '422':
- $ref: '#/components/responses/invalid_request_error'
- '500':
- $ref: '#/components/responses/500_error'
+ schema: {}
components:
responses:
default_error:
@@ -6210,1888 +1049,1841 @@ components:
Where `{sid}` is the value of `connect.sid` that you copied.
schemas:
- Address:
- title: Address
- description: An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
+ AdminDeletePricingRuleTypesRuleTypeReq:
type: object
- required:
- - address_1
- - address_2
- - city
- - company
- - country_code
- - created_at
- - customer_id
- - deleted_at
- - first_name
- - id
- - last_name
- - metadata
- - phone
- - postal_code
- - province
- - updated_at
+ description: SUMMARY
+ x-schemaName: AdminDeletePricingRuleTypesRuleTypeReq
+ properties: {}
+ AdminGetPricingRuleTypesParams:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminGetPricingRuleTypesParams
properties:
+ rule_attribute:
+ type: array
+ description: The pricing's rule attribute.
+ items:
+ type: string
+ title: rule_attribute
+ description: The rule attribute's details.
+ expand:
+ type: string
+ title: expand
+ description: The pricing's expand.
+ fields:
+ type: string
+ title: fields
+ description: The pricing's fields.
+ offset:
+ type: number
+ title: offset
+ description: The pricing's offset.
+ limit:
+ type: number
+ title: limit
+ description: The pricing's limit.
+ order:
+ type: string
+ title: order
+ description: The pricing's order.
+ AdminGetPricingRuleTypesRuleTypeParams:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminGetPricingRuleTypesRuleTypeParams
+ properties:
+ expand:
+ type: string
+ title: expand
+ description: The pricing's expand.
+ fields:
+ type: string
+ title: fields
+ description: The pricing's fields.
+ AdminGetProductsParams:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminGetProductsParams
+ properties:
+ q:
+ type: string
+ title: q
+ description: The product's q.
id:
- type: string
- description: ID of the address
- example: addr_01G8ZC9VS1XVE149MGH2J7QSSH
- customer_id:
- description: ID of the customer this address belongs to
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: Available if the relation `customer` is expanded.
- nullable: true
- type: object
- company:
- description: Company name
- nullable: true
- type: string
- example: Acme
- first_name:
- description: First name
- nullable: true
- type: string
- example: Arno
- last_name:
- description: Last name
- nullable: true
- type: string
- example: Willms
- address_1:
- description: Address line 1
- nullable: true
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- nullable: true
- type: string
- example: Suite 369
- city:
- description: City
- nullable: true
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- nullable: true
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- country:
- description: A country object.
- x-expandable: country
- nullable: true
- $ref: '#/components/schemas/Country'
- province:
- description: Province
- nullable: true
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- nullable: true
- type: string
- example: 72093
- phone:
- description: Phone Number
- nullable: true
- type: string
- example: 16128234334802
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- AddressCreatePayload:
- type: object
- description: Address fields used when creating an address.
- required:
- - first_name
- - last_name
- - address_1
- - city
- - country_code
- - postal_code
- properties:
- first_name:
- description: First name
- type: string
- example: Arno
- last_name:
- description: Last name
- type: string
- example: Willms
- phone:
- type: string
- description: Phone Number
- example: 16128234334802
- company:
- type: string
- address_1:
- description: Address line 1
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- type: string
- example: Suite 369
- city:
- description: City
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- province:
- description: Province
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- type: string
- example: 72093
- metadata:
- type: object
- example:
- car: white
- description: An optional key-value map with additional details
- AddressPayload:
- type: object
- description: Address fields used when creating/updating an address.
- properties:
- first_name:
- description: First name
- type: string
- example: Arno
- last_name:
- description: Last name
- type: string
- example: Willms
- phone:
- type: string
- description: Phone Number
- example: 16128234334802
- company:
- type: string
- description: Company
- address_1:
- description: Address line 1
- type: string
- example: 14433 Kemmer Court
- address_2:
- description: Address line 2
- type: string
- example: Suite 369
- city:
- description: City
- type: string
- example: South Geoffreyview
- country_code:
- description: The 2 character ISO code of the country in lower case
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- example: st
- province:
- description: Province
- type: string
- example: Kentucky
- postal_code:
- description: Postal Code
- type: string
- example: 72093
- metadata:
- type: object
- example:
- car: white
- description: An optional key-value map with additional details
- BatchJob:
- title: Batch Job
- description: A Batch Job indicates an asynchronus task stored in the Medusa backend. Its status determines whether it has been executed or not.
- type: object
- required:
- - canceled_at
- - completed_at
- - confirmed_at
- - context
- - created_at
- - created_by
- - deleted_at
- - dry_run
- - failed_at
- - id
- - pre_processed_at
- - processing_at
- - result
- - status
- - type
- - updated_at
- properties:
- id:
- description: The unique identifier for the batch job.
- type: string
- example: batch_01G8T782965PYFG0751G0Z38B4
- type:
- description: The type of batch job.
- type: string
- enum:
- - product-import
- - product-export
+ oneOf:
+ - type: string
+ title: id
+ description: The product's ID.
+ - type: array
+ description: The product's ID.
+ items:
+ type: string
+ title: id
+ description: The id's ID.
status:
- description: The status of the batch job.
+ type: array
+ description: The product's status.
+ items: {}
+ title:
type: string
- enum:
- - created
- - pre_processed
- - confirmed
- - processing
- - completed
- - canceled
- - failed
- default: created
- created_by:
- description: The unique identifier of the user that created the batch job.
- nullable: true
+ title: title
+ description: The product's title.
+ handle:
type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- created_by_user:
- description: The details of the user that created the batch job.
- x-expandable: created_by_user
- nullable: true
- $ref: '#/components/schemas/User'
- context:
- description: The context of the batch job, the type of the batch job determines what the context should contain.
- nullable: true
- type: object
- example:
- shape:
- prices:
- - region: null
- currency_code: eur
- dynamicImageColumnCount: 4
- dynamicOptionColumnCount: 2
- list_config:
- skip: 0
- take: 50
- order:
- created_at: DESC
- relations:
- - variants
- - variant.prices
- - images
- dry_run:
- description: Specify if the job must apply the modifications or not.
+ title: handle
+ description: The product's handle.
+ is_giftcard:
type: boolean
- default: false
- result:
- description: The result of the batch job.
- nullable: true
- allOf:
- - type: object
- example: {}
- - type: object
- properties:
- count:
- type: number
- advancement_count:
- type: number
- progress:
- type: number
- errors:
- type: object
- properties:
- message:
+ title: is_giftcard
+ description: The product's is giftcard.
+ price_list_id:
+ type: array
+ description: The product's price list id.
+ items:
+ type: string
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The product's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The product's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The product's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The product's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The product's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The product's $and.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties:
+ q:
+ type: string
+ title: q
+ description: The $and's q.
+ id:
+ oneOf:
+ - type: string
+ title: id
+ description: The $and's ID.
+ - type: array
+ description: The $and's ID.
+ items:
type: string
- code:
+ title: id
+ description: The id's ID.
+ status:
+ type: array
+ description: The $and's status.
+ items: {}
+ title:
+ type: string
+ title: title
+ description: The $and's title.
+ handle:
+ type: string
+ title: handle
+ description: The $and's handle.
+ is_giftcard:
+ type: boolean
+ title: is_giftcard
+ description: The $and's is giftcard.
+ price_list_id:
+ type: array
+ description: The $and's price list id.
+ items:
+ type: string
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The $and's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The $and's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The $and's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The $and's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The $and's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The $and's details.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties:
+ q:
+ type: string
+ title: q
+ description: The $and's q.
+ id:
oneOf:
- type: string
- - type: number
- err:
+ title: id
+ description: The $and's ID.
+ - type: array
+ description: The $and's ID.
+ items:
+ type: string
+ title: id
+ description: The id's ID.
+ status:
type: array
- stat_descriptors:
+ description: The $and's status.
+ items: {}
+ title:
+ type: string
+ title: title
+ description: The $and's title.
+ handle:
+ type: string
+ title: handle
+ description: The $and's handle.
+ is_giftcard:
+ type: boolean
+ title: is_giftcard
+ description: The $and's is giftcard.
+ price_list_id:
+ type: array
+ description: The $and's price list id.
+ items:
+ type: string
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The $and's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The $and's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The $and's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The $and's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The $and's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The $and's details.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ $or:
+ type: array
+ description: The $and's $or.
+ items:
+ type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ expand:
+ type: string
+ title: expand
+ description: The $and's expand.
+ fields:
+ type: string
+ title: fields
+ description: The $and's fields.
+ offset:
+ type: number
+ title: offset
+ description: The $and's offset.
+ limit:
+ type: number
+ title: limit
+ description: The $and's limit.
+ order:
+ type: string
+ title: order
+ description: The $and's order.
+ $or:
+ type: array
+ description: The $and's $or.
+ items:
type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
properties:
- key:
+ q:
type: string
- name:
+ title: q
+ description: The $or's q.
+ id:
+ oneOf:
+ - type: string
+ title: id
+ description: The $or's ID.
+ - type: array
+ description: The $or's ID.
+ items:
+ type: string
+ title: id
+ description: The id's ID.
+ status:
+ type: array
+ description: The $or's status.
+ items: {}
+ title:
type: string
- message:
+ title: title
+ description: The $or's title.
+ handle:
type: string
- file_key:
+ title: handle
+ description: The $or's handle.
+ is_giftcard:
+ type: boolean
+ title: is_giftcard
+ description: The $or's is giftcard.
+ price_list_id:
+ type: array
+ description: The $or's price list id.
+ items:
+ type: string
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The $or's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The $or's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The $or's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The $or's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The $or's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The $or's $and.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ $or:
+ type: array
+ description: The $or's details.
+ items:
+ type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ expand:
+ type: string
+ title: expand
+ description: The $or's expand.
+ fields:
+ type: string
+ title: fields
+ description: The $or's fields.
+ offset:
+ type: number
+ title: offset
+ description: The $or's offset.
+ limit:
+ type: number
+ title: limit
+ description: The $or's limit.
+ order:
+ type: string
+ title: order
+ description: The $or's order.
+ expand:
+ type: string
+ title: expand
+ description: The $and's expand.
+ fields:
+ type: string
+ title: fields
+ description: The $and's fields.
+ offset:
+ type: number
+ title: offset
+ description: The $and's offset.
+ limit:
+ type: number
+ title: limit
+ description: The $and's limit.
+ order:
+ type: string
+ title: order
+ description: The $and's order.
+ $or:
+ type: array
+ description: The product's $or.
+ items:
+ type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
+ properties:
+ q:
+ type: string
+ title: q
+ description: The $or's q.
+ id:
+ oneOf:
+ - type: string
+ title: id
+ description: The $or's ID.
+ - type: array
+ description: The $or's ID.
+ items:
+ type: string
+ title: id
+ description: The id's ID.
+ status:
+ type: array
+ description: The $or's status.
+ items: {}
+ title:
+ type: string
+ title: title
+ description: The $or's title.
+ handle:
+ type: string
+ title: handle
+ description: The $or's handle.
+ is_giftcard:
+ type: boolean
+ title: is_giftcard
+ description: The $or's is giftcard.
+ price_list_id:
+ type: array
+ description: The $or's price list id.
+ items:
type: string
- file_size:
- type: number
- example:
- errors:
- - err: []
- code: unknown
- message: Method not implemented.
- stat_descriptors:
- - key: product-export-count
- name: Product count to export
- message: There will be 8 products exported by this action
- pre_processed_at:
- description: The date from which the job has been pre-processed.
- nullable: true
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The $or's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The $or's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The $or's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The $or's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The $or's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The $or's $and.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties:
+ q:
+ type: string
+ title: q
+ description: The $and's q.
+ id:
+ oneOf:
+ - type: string
+ title: id
+ description: The $and's ID.
+ - type: array
+ description: The $and's ID.
+ items:
+ type: string
+ title: id
+ description: The id's ID.
+ status:
+ type: array
+ description: The $and's status.
+ items: {}
+ title:
+ type: string
+ title: title
+ description: The $and's title.
+ handle:
+ type: string
+ title: handle
+ description: The $and's handle.
+ is_giftcard:
+ type: boolean
+ title: is_giftcard
+ description: The $and's is giftcard.
+ price_list_id:
+ type: array
+ description: The $and's price list id.
+ items:
+ type: string
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The $and's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The $and's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The $and's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The $and's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The $and's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The $and's details.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ $or:
+ type: array
+ description: The $and's $or.
+ items:
+ type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ expand:
+ type: string
+ title: expand
+ description: The $and's expand.
+ fields:
+ type: string
+ title: fields
+ description: The $and's fields.
+ offset:
+ type: number
+ title: offset
+ description: The $and's offset.
+ limit:
+ type: number
+ title: limit
+ description: The $and's limit.
+ order:
+ type: string
+ title: order
+ description: The $and's order.
+ $or:
+ type: array
+ description: The $or's details.
+ items:
+ type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
+ properties:
+ q:
+ type: string
+ title: q
+ description: The $or's q.
+ id:
+ oneOf:
+ - type: string
+ title: id
+ description: The $or's ID.
+ - type: array
+ description: The $or's ID.
+ items:
+ type: string
+ title: id
+ description: The id's ID.
+ status:
+ type: array
+ description: The $or's status.
+ items: {}
+ title:
+ type: string
+ title: title
+ description: The $or's title.
+ handle:
+ type: string
+ title: handle
+ description: The $or's handle.
+ is_giftcard:
+ type: boolean
+ title: is_giftcard
+ description: The $or's is giftcard.
+ price_list_id:
+ type: array
+ description: The $or's price list id.
+ items:
+ type: string
+ title: price_list_id
+ description: The price list id's details.
+ sales_channel_id:
+ type: array
+ description: The $or's sales channel id.
+ items:
+ type: string
+ title: sales_channel_id
+ description: The sales channel id's details.
+ collection_id:
+ type: array
+ description: The $or's collection id.
+ items:
+ type: string
+ title: collection_id
+ description: The collection id's details.
+ tags:
+ type: array
+ description: The $or's tags.
+ items:
+ type: string
+ title: tags
+ description: The tag's tags.
+ type_id:
+ type: array
+ description: The $or's type id.
+ items:
+ type: string
+ title: type_id
+ description: The type id's details.
+ variants:
+ type: object
+ description: The $or's variants.
+ properties: {}
+ created_at: {}
+ updated_at: {}
+ deleted_at: {}
+ $and:
+ type: array
+ description: The $or's $and.
+ items:
+ type: object
+ description: The $and's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ $or:
+ type: array
+ description: The $or's details.
+ items:
+ type: object
+ description: The $or's details.
+ x-schemaName: AdminGetProductsParams
+ properties: {}
+ expand:
+ type: string
+ title: expand
+ description: The $or's expand.
+ fields:
+ type: string
+ title: fields
+ description: The $or's fields.
+ offset:
+ type: number
+ title: offset
+ description: The $or's offset.
+ limit:
+ type: number
+ title: limit
+ description: The $or's limit.
+ order:
+ type: string
+ title: order
+ description: The $or's order.
+ expand:
+ type: string
+ title: expand
+ description: The $or's expand.
+ fields:
+ type: string
+ title: fields
+ description: The $or's fields.
+ offset:
+ type: number
+ title: offset
+ description: The $or's offset.
+ limit:
+ type: number
+ title: limit
+ description: The $or's limit.
+ order:
+ type: string
+ title: order
+ description: The $or's order.
+ expand:
type: string
- format: date-time
- processing_at:
- description: The date the job is processing at.
- nullable: true
+ title: expand
+ description: The product's expand.
+ fields:
type: string
- format: date-time
- confirmed_at:
- description: The date when the confirmation has been done.
- nullable: true
- type: string
- format: date-time
- completed_at:
- description: The date of the completion.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date of the concellation.
- nullable: true
- type: string
- format: date-time
- failed_at:
- description: The date when the job failed.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was last updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- Cart:
- title: Cart
- description: A cart represents a virtual shopping bag. It can be used to complete an order, a swap, or a claim.
- type: object
- required:
- - billing_address_id
- - completed_at
- - context
- - created_at
- - customer_id
- - deleted_at
- - email
- - id
- - idempotency_key
- - metadata
- - payment_authorized_at
- - payment_id
- - payment_session
- - region_id
- - shipping_address_id
- - type
- - updated_at
- properties:
- id:
- description: The cart's ID
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- email:
- description: The email associated with the cart
- nullable: true
- type: string
- format: email
- billing_address_id:
- description: The billing address's ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the cart.
- x-expandable: billing_address
- nullable: true
- $ref: '#/components/schemas/Address'
- shipping_address_id:
- description: The shipping address's ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address associated with the cart.
- x-expandable: shipping_address
- nullable: true
- $ref: '#/components/schemas/Address'
- items:
- description: The line items added to the cart.
- type: array
- x-expandable: items
- items:
- $ref: '#/components/schemas/LineItem'
- region_id:
- description: The region's ID
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region associated with the cart.
- x-expandable: region
- nullable: true
- $ref: '#/components/schemas/Region'
- discounts:
- description: An array of details of all discounts applied to the cart.
- type: array
- x-expandable: discounts
- items:
- $ref: '#/components/schemas/Discount'
- gift_cards:
- description: An array of details of all gift cards applied to the cart.
- type: array
- x-expandable: gift_cards
- items:
- $ref: '#/components/schemas/GiftCard'
- customer_id:
- description: The customer's ID
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer the cart belongs to.
- x-expandable: customer
- nullable: true
- type: object
- payment_session:
- description: The details of the selected payment session in the cart.
- x-expandable: payment_session
- nullable: true
- type: object
- payment_sessions:
- description: The details of all payment sessions created on the cart.
- type: array
- x-expandable: payment_sessions
- items:
- type: object
- payment_id:
- description: The payment's ID if available
- nullable: true
- type: string
- example: pay_01G8ZCC5W42ZNY842124G7P5R9
- payment:
- description: The details of the payment associated with the cart.
- nullable: true
- x-expandable: payment
- type: object
- shipping_methods:
- description: The details of the shipping methods added to the cart.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: '#/components/schemas/ShippingMethod'
- type:
- description: The cart's type.
- type: string
- enum:
- - default
- - swap
- - draft_order
- - payment_link
- - claim
- default: default
- completed_at:
- description: The date with timezone at which the cart was completed.
- nullable: true
- type: string
- format: date-time
- payment_authorized_at:
- description: The date with timezone at which the payment was authorized.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: Randomly generated key used to continue the completion of a cart in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- context:
- description: The context of the cart which can include info like IP or user agent.
- nullable: true
- type: object
- example:
- ip: '::1'
- user_agent: PostmanRuntime/7.29.2
- sales_channel_id:
- description: The sales channel ID the cart is associated with.
- nullable: true
- type: string
- example: null
- sales_channel:
- description: The details of the sales channel associated with the cart.
- nullable: true
- x-expandable: sales_channel
- $ref: '#/components/schemas/SalesChannel'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- shipping_total:
- description: The total of shipping
- type: integer
- example: 1000
- discount_total:
- description: The total of discount rounded
- type: integer
- example: 800
- raw_discount_total:
- description: The total of discount
- type: integer
- example: 800
- item_tax_total:
- description: The total of items with taxes
- type: integer
- example: 8000
- shipping_tax_total:
- description: The total of shipping with taxes
- type: integer
- example: 1000
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- refunded_total:
- description: The total amount refunded if the order associated with this cart is returned.
- type: integer
- example: 0
- total:
- description: The total amount of the cart
- type: integer
- example: 8200
- subtotal:
- description: The subtotal of the cart
- type: integer
- example: 8000
- refundable_amount:
- description: The amount that can be refunded
- type: integer
- example: 8200
- gift_card_total:
- description: The total of gift cards
- type: integer
- example: 0
- gift_card_tax_total:
- description: The total of gift cards with taxes
- type: integer
- example: 0
- sales_channels:
- description: The associated sales channels.
- type: array
- nullable: true
- x-expandable: sales_channels
- items:
- $ref: '#/components/schemas/SalesChannel'
- ClaimImage:
- title: Claim Image
- description: The details of an image attached to a claim.
- type: object
- required:
- - claim_item_id
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - url
- properties:
- id:
- description: The claim image's ID
- type: string
- example: cimg_01G8ZH853Y6TFXWPG5EYE81X63
- claim_item_id:
- description: The ID of the claim item associated with the image
- type: string
- claim_item:
- description: The details of the claim item this image is associated with.
- nullable: true
- x-expandable: claim_item
- type: object
- url:
- description: The URL of the image
- type: string
- format: uri
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ClaimItem:
- title: Claim Item
- description: A claim item is an item created as part of a claim. It references an item in the order that should be exchanged or refunded.
- type: object
- required:
- - claim_order_id
- - created_at
- - deleted_at
- - id
- - item_id
- - metadata
- - note
- - quantity
- - reason
- - updated_at
- - variant_id
- properties:
- id:
- description: The claim item's ID
- type: string
- example: citm_01G8ZH853Y6TFXWPG5EYE81X63
- images:
- description: The claim images that are attached to the claim item.
- type: array
- x-expandable: images
- items:
- $ref: '#/components/schemas/ClaimImage'
- claim_order_id:
- description: The ID of the claim this item is associated with.
- type: string
- claim_order:
- description: The details of the claim this item belongs to.
- x-expandable: claim_order
- nullable: true
- type: object
- item_id:
- description: The ID of the line item that the claim item refers to.
- type: string
- example: item_01G8ZM25TN49YV9EQBE2NC27KC
- item:
- description: The details of the line item in the original order that this claim item refers to.
- x-expandable: item
- nullable: true
- $ref: '#/components/schemas/LineItem'
- variant_id:
- description: The ID of the product variant that is claimed.
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant to potentially replace the item in the original order.
- x-expandable: variant
- nullable: true
- $ref: '#/components/schemas/ProductVariant'
- reason:
- description: The reason for the claim
- type: string
- enum:
- - missing_item
- - wrong_item
- - production_failure
- - other
- note:
- description: An optional note about the claim, for additional information
- nullable: true
- type: string
- example: I don't like it.
- quantity:
- description: The quantity of the item that is being claimed; must be less than or equal to the amount purchased in the original order.
- type: integer
- example: 1
- tags:
- description: User defined tags for easy filtering and grouping.
- type: array
- x-expandable: tags
- items:
- $ref: '#/components/schemas/ClaimTag'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ClaimOrder:
- title: Claim
- description: A Claim represents a group of faulty or missing items. It consists of claim items that refer to items in the original order that should be replaced or refunded. It also includes details related to shipping and fulfillment.
- type: object
- required:
- - canceled_at
- - created_at
- - deleted_at
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - order_id
- - payment_status
- - refund_amount
- - shipping_address_id
- - type
- - updated_at
- properties:
- id:
- description: The claim's ID
- type: string
- example: claim_01G8ZH853Y6TFXWPG5EYE81X63
- type:
- description: The claim's type
- type: string
- enum:
- - refund
- - replace
- payment_status:
- description: The status of the claim's payment
- type: string
- enum:
- - na
- - not_refunded
- - refunded
- default: na
- fulfillment_status:
- description: The claim's fulfillment status
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- default: not_fulfilled
- claim_items:
- description: The details of the items that should be replaced or refunded.
- type: array
- x-expandable: claim_items
- items:
- $ref: '#/components/schemas/ClaimItem'
- additional_items:
- description: The details of the new items to be shipped when the claim's type is `replace`
- type: array
- x-expandable: additional_items
- items:
- $ref: '#/components/schemas/LineItem'
- order_id:
- description: The ID of the order that the claim comes from.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
+ title: fields
+ description: The product's fields.
+ offset:
+ type: number
+ title: offset
+ description: The product's offset.
+ limit:
+ type: number
+ title: limit
+ description: The product's limit.
order:
- description: The details of the order that this claim was created for.
- x-expandable: order
- nullable: true
- type: object
- return_order:
- description: The details of the return associated with the claim if the claim's type is `replace`.
- x-expandable: return_order
- nullable: true
- type: object
- shipping_address_id:
- description: The ID of the address that the new items should be shipped to
- nullable: true
type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the address that new items should be shipped to.
- x-expandable: shipping_address
- nullable: true
- $ref: '#/components/schemas/Address'
- shipping_methods:
- description: The details of the shipping methods that the claim order will be shipped with.
+ title: order
+ description: The product's order.
+ AdminGetPromotionsParams:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminGetPromotionsParams
+ properties:
+ code:
+ type: string
+ title: code
+ description: The promotion's code.
+ expand:
+ type: string
+ title: expand
+ description: The promotion's expand.
+ fields:
+ type: string
+ title: fields
+ description: The promotion's fields.
+ offset:
+ type: number
+ title: offset
+ description: The promotion's offset.
+ limit:
+ type: number
+ title: limit
+ description: The promotion's limit.
+ order:
+ type: string
+ title: order
+ description: The promotion's order.
+ AdminPostCampaignsReq:
+ type: object
+ description: The promotion's campaign.
+ x-schemaName: AdminPostCampaignsReq
+ required:
+ - name
+ properties:
+ name:
+ type: string
+ title: name
+ description: The campaign's name.
+ campaign_identifier:
+ type: string
+ title: campaign_identifier
+ description: The campaign's campaign identifier.
+ description:
+ type: string
+ title: description
+ description: The campaign's description.
+ currency:
+ type: string
+ title: currency
+ description: The campaign's currency.
+ budget:
+ $ref: '#/components/schemas/CampaignBudget'
+ starts_at:
+ type: string
+ title: starts_at
+ description: The campaign's starts at.
+ ends_at:
+ type: string
+ title: ends_at
+ description: The campaign's ends at.
+ promotions:
type: array
- x-expandable: shipping_methods
- items:
- $ref: '#/components/schemas/ShippingMethod'
- fulfillments:
- description: The fulfillments of the new items to be shipped
- type: array
- x-expandable: fulfillments
+ description: The campaign's promotions.
items:
type: object
- refund_amount:
- description: The amount that will be refunded in conjunction with the claim
- nullable: true
- type: integer
- example: 1000
- canceled_at:
- description: The date with timezone at which the claim was canceled.
- nullable: true
+ description: The promotion's promotions.
+ x-schemaName: IdObject
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ title: id
+ description: The promotion's ID.
+ AdminPostCustomerGroupsGroupCustomersBatchReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostCustomerGroupsGroupCustomersBatchReq
+ required:
+ - customer_ids
+ properties:
+ customer_ids:
+ type: array
+ description: The customer group's customer ids.
+ items:
+ type: object
+ description: The customer id's customer ids.
+ x-schemaName: CustomerGroupsBatchCustomer
+ required:
+ - id
+ properties:
+ id:
+ type: string
+ title: id
+ description: The customer id's ID.
+ AdminPostFulfillmentShippingOptionsRulesBatchAddReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchAddReq
+ required:
+ - rules
+ properties:
+ rules:
+ type: array
+ description: The fulfillment's rules.
+ items:
+ type: object
+ description: The rule's rules.
+ x-schemaName: FulfillmentRuleCreate
+ required:
+ - operator
+ - attribute
+ - value
+ properties:
+ operator: {}
+ attribute:
+ type: string
+ title: attribute
+ description: The rule's attribute.
+ value:
+ oneOf:
+ - type: string
+ title: value
+ description: The rule's value.
+ - type: array
+ description: The rule's value.
+ items:
+ type: string
+ title: value
+ description: The value's details.
+ AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostFulfillmentShippingOptionsRulesBatchRemoveReq
+ required:
+ - rule_ids
+ properties:
+ rule_ids:
+ type: array
+ description: The fulfillment's rule ids.
+ items:
+ type: string
+ title: rule_ids
+ description: The rule id's rule ids.
+ AdminPostInventoryItemsInventoryItemReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostInventoryItemsInventoryItemReq
+ properties:
+ sku:
type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
+ title: sku
+ description: The inventory item's sku.
+ origin_country:
type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
+ title: origin_country
+ description: The inventory item's origin country.
+ hs_code:
type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
+ title: hs_code
+ description: The inventory item's hs code.
+ mid_code:
type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- no_notification:
- description: Flag for describing whether or not notifications related to this should be send.
- nullable: true
+ title: mid_code
+ description: The inventory item's mid code.
+ material:
+ type: string
+ title: material
+ description: The inventory item's material.
+ weight:
+ type: number
+ title: weight
+ description: The inventory item's weight.
+ height:
+ type: number
+ title: height
+ description: The inventory item's height.
+ length:
+ type: number
+ title: length
+ description: The inventory item's length.
+ width:
+ type: number
+ title: width
+ description: The inventory item's width.
+ title:
+ type: string
+ title: title
+ description: The inventory item's title.
+ description:
+ type: string
+ title: description
+ description: The inventory item's description.
+ thumbnail:
+ type: string
+ title: thumbnail
+ description: The inventory item's thumbnail.
+ requires_shipping:
type: boolean
- example: false
- idempotency_key:
- description: Randomly generated key used to continue the completion of the cart associated with the claim in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- ClaimTag:
- title: Claim Tag
- description: Claim Tags are user defined tags that can be assigned to claim items for easy filtering and grouping.
+ title: requires_shipping
+ description: The inventory item's requires shipping.
+ AdminPostInventoryItemsItemLocationLevelsLevelReq:
type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
+ description: SUMMARY
+ x-schemaName: AdminPostInventoryItemsItemLocationLevelsLevelReq
properties:
- id:
- description: The claim tag's ID
+ incoming_quantity:
+ type: number
+ title: incoming_quantity
+ description: The inventory item's incoming quantity.
+ stocked_quantity:
+ type: number
+ title: stocked_quantity
+ description: The inventory item's stocked quantity.
+ AdminPostInventoryItemsItemLocationLevelsReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostInventoryItemsItemLocationLevelsReq
+ required:
+ - location_id
+ - stocked_quantity
+ properties:
+ location_id:
type: string
- example: ctag_01G8ZCC5Y63B95V6B5SHBZ91S4
- value:
- description: The value that the claim tag holds
+ title: location_id
+ description: The inventory item's location id.
+ stocked_quantity:
+ type: number
+ title: stocked_quantity
+ description: The inventory item's stocked quantity.
+ incoming_quantity:
+ type: number
+ title: incoming_quantity
+ description: The inventory item's incoming quantity.
+ AdminPostInventoryItemsReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostInventoryItemsReq
+ properties:
+ sku:
type: string
- example: Damaged
- created_at:
- description: The date with timezone at which the resource was created.
+ title: sku
+ description: The inventory item's sku.
+ hs_code:
type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
+ title: hs_code
+ description: The inventory item's hs code.
+ weight:
+ type: number
+ title: weight
+ description: The inventory item's weight.
+ length:
+ type: number
+ title: length
+ description: The inventory item's length.
+ height:
+ type: number
+ title: height
+ description: The inventory item's height.
+ width:
+ type: number
+ title: width
+ description: The inventory item's width.
+ origin_country:
type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
+ title: origin_country
+ description: The inventory item's origin country.
+ mid_code:
type: string
- format: date-time
+ title: mid_code
+ description: The inventory item's mid code.
+ material:
+ type: string
+ title: material
+ description: The inventory item's material.
+ title:
+ type: string
+ title: title
+ description: The inventory item's title.
+ description:
+ type: string
+ title: description
+ description: The inventory item's description.
+ thumbnail:
+ type: string
+ title: thumbnail
+ description: The inventory item's thumbnail.
metadata:
- description: An optional key-value map with additional details
- nullable: true
type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- Country:
- title: Country
- description: Country details
+ description: The inventory item's metadata.
+ properties: {}
+ AdminPostInvitesInviteAcceptReq:
type: object
+ description: SUMMARY
+ x-schemaName: AdminPostInvitesInviteAcceptReq
required:
- - display_name
- - id
- - iso_2
- - iso_3
- - name
- - num_code
- - region_id
+ - first_name
+ - last_name
properties:
- id:
- description: The country's ID
+ first_name:
type: string
- example: 109
- iso_2:
- description: The 2 character ISO code of the country in lower case
+ title: first_name
+ description: The invite's first name.
+ last_name:
type: string
- example: it
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- iso_3:
- description: The 2 character ISO code of the country in lower case
- type: string
- example: ita
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3#Officially_assigned_code_elements
- description: See a list of codes.
- num_code:
- description: The numerical ISO code for the country.
- type: string
- example: 380
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_numeric#Officially_assigned_code_elements
- description: See a list of codes.
- name:
- description: The normalized country name in upper case.
- type: string
- example: ITALY
- display_name:
- description: The country name appropriate for display.
- type: string
- example: Italy
- region_id:
- description: The region ID this country is associated with.
- nullable: true
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region the country is associated with.
- x-expandable: region
- nullable: true
- type: object
- CreateStockLocationInput:
- title: Create Stock Location Input
- description: Represents the Input to create a Stock Location
+ title: last_name
+ description: The invite's last name.
+ AdminPostPaymentsCapturesReq:
type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPaymentsCapturesReq
+ properties:
+ amount:
+ type: number
+ title: amount
+ description: The payment's amount.
+ AdminPostPaymentsRefundsReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPaymentsRefundsReq
+ properties:
+ amount:
+ type: number
+ title: amount
+ description: The payment's amount.
+ AdminPostPriceListsPriceListPricesBatchAddReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPriceListsPriceListPricesBatchAddReq
+ required:
+ - prices
+ properties:
+ prices:
+ type: array
+ description: The price list's prices.
+ items:
+ type: object
+ description: The price's prices.
+ x-schemaName: AdminPriceListPricesCreateReq
+ required:
+ - currency_code
+ - amount
+ - variant_id
+ properties:
+ currency_code:
+ type: string
+ title: currency_code
+ description: The price's currency code.
+ amount:
+ type: number
+ title: amount
+ description: The price's amount.
+ variant_id:
+ type: string
+ title: variant_id
+ description: The price's variant id.
+ min_quantity:
+ type: number
+ title: min_quantity
+ description: The price's min quantity.
+ max_quantity:
+ type: number
+ title: max_quantity
+ description: The price's max quantity.
+ rules:
+ type: object
+ description: The price's rules.
+ properties: {}
+ AdminPostPriceListsPriceListPricesBatchRemoveReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPriceListsPriceListPricesBatchRemoveReq
+ required:
+ - ids
+ properties:
+ ids:
+ type: array
+ description: The price list's ids.
+ items:
+ type: string
+ title: ids
+ description: The id's ids.
+ AdminPostPriceListsPriceListReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPriceListsPriceListReq
+ required:
+ - prices
+ properties:
+ title:
+ type: string
+ title: title
+ description: The price list's title.
+ description:
+ type: string
+ title: description
+ description: The price list's description.
+ starts_at:
+ type: string
+ title: starts_at
+ description: The price list's starts at.
+ ends_at:
+ type: string
+ title: ends_at
+ description: The price list's ends at.
+ status: {}
+ type: {}
+ prices:
+ type: array
+ description: The price list's prices.
+ items:
+ type: object
+ description: The price's prices.
+ x-schemaName: AdminPriceListPricesCreateReq
+ required:
+ - currency_code
+ - amount
+ - variant_id
+ properties:
+ currency_code:
+ type: string
+ title: currency_code
+ description: The price's currency code.
+ amount:
+ type: number
+ title: amount
+ description: The price's amount.
+ variant_id:
+ type: string
+ title: variant_id
+ description: The price's variant id.
+ min_quantity:
+ type: number
+ title: min_quantity
+ description: The price's min quantity.
+ max_quantity:
+ type: number
+ title: max_quantity
+ description: The price's max quantity.
+ rules:
+ type: object
+ description: The price's rules.
+ properties: {}
+ rules:
+ type: object
+ description: The price list's rules.
+ properties: {}
+ AdminPostPriceListsReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPriceListsReq
+ required:
+ - title
+ - description
+ - type
+ - prices
+ properties:
+ title:
+ type: string
+ title: title
+ description: The price list's title.
+ description:
+ type: string
+ title: description
+ description: The price list's description.
+ starts_at:
+ type: string
+ title: starts_at
+ description: The price list's starts at.
+ ends_at:
+ type: string
+ title: ends_at
+ description: The price list's ends at.
+ status: {}
+ type: {}
+ prices:
+ type: array
+ description: The price list's prices.
+ items:
+ type: object
+ description: The price's prices.
+ x-schemaName: AdminPriceListPricesCreateReq
+ required:
+ - currency_code
+ - amount
+ - variant_id
+ properties:
+ currency_code:
+ type: string
+ title: currency_code
+ description: The price's currency code.
+ amount:
+ type: number
+ title: amount
+ description: The price's amount.
+ variant_id:
+ type: string
+ title: variant_id
+ description: The price's variant id.
+ min_quantity:
+ type: number
+ title: min_quantity
+ description: The price's min quantity.
+ max_quantity:
+ type: number
+ title: max_quantity
+ description: The price's max quantity.
+ rules:
+ type: object
+ description: The price's rules.
+ properties: {}
+ rules:
+ type: object
+ description: The price list's rules.
+ properties: {}
+ AdminPostPricingRuleTypesReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPricingRuleTypesReq
+ required:
+ - name
+ - rule_attribute
+ - default_priority
+ properties:
+ name:
+ type: string
+ title: name
+ description: The pricing's name.
+ rule_attribute:
+ type: string
+ title: rule_attribute
+ description: The pricing's rule attribute.
+ default_priority:
+ type: number
+ title: default_priority
+ description: The pricing's default priority.
+ AdminPostPricingRuleTypesRuleTypeReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPricingRuleTypesRuleTypeReq
+ properties:
+ name:
+ type: string
+ title: name
+ description: The pricing's name.
+ rule_attribute:
+ type: string
+ title: rule_attribute
+ description: The pricing's rule attribute.
+ default_priority:
+ type: number
+ title: default_priority
+ description: The pricing's default priority.
+ AdminPostPromotionsPromotionReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPromotionsPromotionReq
+ properties:
+ code:
+ type: string
+ title: code
+ description: The promotion's code.
+ is_automatic:
+ type: boolean
+ title: is_automatic
+ description: The promotion's is automatic.
+ type: {}
+ campaign_id:
+ type: string
+ title: campaign_id
+ description: The promotion's campaign id.
+ campaign:
+ $ref: '#/components/schemas/AdminPostCampaignsReq'
+ application_method:
+ $ref: '#/components/schemas/ApplicationMethodsMethodPostReq'
+ rules:
+ type: array
+ description: The promotion's rules.
+ items:
+ type: object
+ description: The rule's rules.
+ x-schemaName: PromotionRule
+ required:
+ - operator
+ - attribute
+ - values
+ properties:
+ operator: {}
+ description:
+ type: string
+ title: description
+ description: The rule's description.
+ attribute:
+ type: string
+ title: attribute
+ description: The rule's attribute.
+ values:
+ type: array
+ description: The rule's values.
+ items:
+ type: string
+ title: values
+ description: The value's values.
+ AdminPostPromotionsPromotionRulesBatchAddReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPromotionsPromotionRulesBatchAddReq
+ required:
+ - rules
+ properties:
+ rules:
+ type: array
+ description: The promotion's rules.
+ items:
+ type: object
+ description: The rule's rules.
+ x-schemaName: PromotionRule
+ required:
+ - operator
+ - attribute
+ - values
+ properties:
+ operator: {}
+ description:
+ type: string
+ title: description
+ description: The rule's description.
+ attribute:
+ type: string
+ title: attribute
+ description: The rule's attribute.
+ values:
+ type: array
+ description: The rule's values.
+ items:
+ type: string
+ title: values
+ description: The value's values.
+ AdminPostPromotionsPromotionRulesBatchRemoveReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPromotionsPromotionRulesBatchRemoveReq
+ required:
+ - rule_ids
+ properties:
+ rule_ids:
+ type: array
+ description: The promotion's rule ids.
+ items:
+ type: string
+ title: rule_ids
+ description: The rule id's rule ids.
+ AdminPostPromotionsPromotionRulesBatchUpdateReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostPromotionsPromotionRulesBatchUpdateReq
+ required:
+ - rules
+ properties:
+ rules:
+ type: array
+ description: The promotion's rules.
+ items:
+ type: object
+ description: The rule's rules.
+ x-schemaName: UpdatePromotionRule
+ required:
+ - id
+ - attribute
+ - values
+ properties:
+ id:
+ type: string
+ title: id
+ description: The rule's ID.
+ operator: {}
+ description:
+ type: string
+ title: description
+ description: The rule's description.
+ attribute:
+ type: string
+ title: attribute
+ description: The rule's attribute.
+ values:
+ type: array
+ description: The rule's values.
+ items:
+ type: string
+ title: values
+ description: The value's values.
+ AdminPostStockLocationsReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostStockLocationsReq
required:
- name
properties:
name:
type: string
- description: The stock location name
+ title: name
+ description: The stock location's name.
+ address:
+ $ref: '#/components/schemas/StockLocationAddress'
address_id:
type: string
- description: The Stock location address ID
- address:
- description: Stock location address object
- allOf:
- - $ref: '#/components/schemas/StockLocationAddressInput'
- - type: object
+ title: address_id
+ description: The stock location's address id.
metadata:
type: object
- description: An optional key-value map with additional details
- example:
- car: white
- Currency:
- title: Currency
- description: Currency
+ description: The stock location's metadata.
+ properties: {}
+ AdminPostTaxRatesReq:
type: object
+ description: SUMMARY
+ x-schemaName: AdminPostTaxRatesReq
required:
- - code
- name
- - symbol
- - symbol_native
+ - tax_region_id
+ properties:
+ rate:
+ type: number
+ title: rate
+ description: The tax rate's rate.
+ code:
+ type: string
+ title: code
+ description: The tax rate's code.
+ rules:
+ type: array
+ description: The tax rate's rules.
+ items:
+ type: object
+ description: The rule's rules.
+ x-schemaName: CreateTaxRateRule
+ required:
+ - reference
+ - reference_id
+ properties:
+ reference:
+ type: string
+ title: reference
+ description: The rule's reference.
+ reference_id:
+ type: string
+ title: reference_id
+ description: The rule's reference id.
+ name:
+ type: string
+ title: name
+ description: The tax rate's name.
+ is_default:
+ type: boolean
+ title: is_default
+ description: The tax rate's is default.
+ is_combinable:
+ type: boolean
+ title: is_combinable
+ description: The tax rate's is combinable.
+ tax_region_id:
+ type: string
+ title: tax_region_id
+ description: The tax rate's tax region id.
+ metadata:
+ type: object
+ description: The tax rate's metadata.
+ properties: {}
+ AdminPostTaxRatesTaxRateReq:
+ type: object
+ description: SUMMARY
+ x-schemaName: AdminPostTaxRatesTaxRateReq
properties:
code:
- description: The 3 character ISO code for the currency.
type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- symbol:
- description: The symbol used to indicate the currency.
- type: string
- example: $
- symbol_native:
- description: The native symbol used to indicate the currency.
- type: string
- example: $
+ title: code
+ description: The tax rate's code.
name:
- description: The written name of the currency
type: string
- example: US Dollar
- includes_tax:
- description: Whether the currency prices include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- CustomShippingOption:
- title: Custom Shipping Option
- description: Custom Shipping Options are overridden Shipping Options. Admins can attach a Custom Shipping Option to a cart in order to set a custom price for a particular Shipping Option.
- type: object
- required:
- - cart_id
- - created_at
- - deleted_at
- - id
- - metadata
- - price
- - shipping_option_id
- - updated_at
- properties:
- id:
- description: The custom shipping option's ID
+ title: name
+ description: The tax rate's name.
+ region_id:
type: string
- example: cso_01G8X99XNB77DMFBJFWX6DN9V9
- price:
- description: The custom price set that will override the shipping option's original price
- type: integer
- example: 1000
- shipping_option_id:
- description: The ID of the Shipping Option that the custom shipping option overrides
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the overridden shipping options.
- x-expandable: shipping_option
- nullable: true
- $ref: '#/components/schemas/ShippingOption'
- cart_id:
- description: The ID of the Cart that the custom shipping option is attached to
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart this shipping option belongs to.
- x-expandable: cart
- nullable: true
- $ref: '#/components/schemas/Cart'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- Customer:
- title: Customer
- description: A customer can make purchases in your store and manage their profile.
- type: object
- required:
- - billing_address_id
- - created_at
- - deleted_at
- - email
- - first_name
- - has_account
- - id
- - last_name
- - metadata
- - phone
- - updated_at
- properties:
- id:
- description: The customer's ID
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- email:
- description: The customer's email
- type: string
- format: email
- first_name:
- description: The customer's first name
- nullable: true
- type: string
- example: Arno
- last_name:
- description: The customer's last name
- nullable: true
- type: string
- example: Willms
- billing_address_id:
- description: The customer's billing address ID
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the customer.
- x-expandable: billing_address
- nullable: true
- $ref: '#/components/schemas/Address'
- shipping_addresses:
- description: The details of the shipping addresses associated with the customer.
- type: array
- x-expandable: shipping_addresses
- items:
- $ref: '#/components/schemas/Address'
- phone:
- description: The customer's phone number
- nullable: true
- type: string
- example: 16128234334802
- has_account:
- description: Whether the customer has an account or not
- type: boolean
- default: false
- orders:
- description: The details of the orders this customer placed.
- type: array
- x-expandable: orders
- items:
- type: object
- groups:
- description: The customer groups the customer belongs to.
- type: array
- x-expandable: groups
- items:
- $ref: '#/components/schemas/CustomerGroup'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- CustomerGroup:
- title: Customer Group
- description: A customer group that can be used to organize customers into groups of similar traits.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - name
- - updated_at
- properties:
- id:
- description: The customer group's ID
- type: string
- example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
- name:
- description: The name of the customer group
- type: string
- example: VIP
- customers:
- description: The details of the customers that belong to the customer group.
- type: array
- x-expandable: customers
- items:
- type: object
- price_lists:
- description: The price lists that are associated with the customer group.
- type: array
- x-expandable: price_lists
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- Discount:
- title: Discount
- description: A discount can be applied to a cart for promotional purposes.
- type: object
- required:
- - code
- - created_at
- - deleted_at
- - ends_at
- - id
- - is_disabled
- - is_dynamic
- - metadata
- - parent_discount_id
- - rule_id
- - starts_at
- - updated_at
- - usage_count
- - usage_limit
- - valid_duration
- properties:
- id:
- description: The discount's ID
- type: string
- example: disc_01F0YESMW10MGHWJKZSDDMN0VN
- code:
- description: A unique code for the discount - this will be used by the customer to apply the discount
- type: string
- example: 10DISC
- is_dynamic:
- description: A flag to indicate if multiple instances of the discount can be generated. I.e. for newsletter discounts
- type: boolean
- example: false
- rule_id:
- description: The ID of the discount rule that defines how the discount will be applied to a cart.
- nullable: true
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- rule:
- description: The details of the discount rule that defines how the discount will be applied to a cart..
- x-expandable: rule
- nullable: true
- $ref: '#/components/schemas/DiscountRule'
- is_disabled:
- description: Whether the Discount has been disabled. Disabled discounts cannot be applied to carts
- type: boolean
- example: false
- parent_discount_id:
- description: The Discount that the discount was created from. This will always be a dynamic discount
- nullable: true
- type: string
- example: disc_01G8ZH853YPY9B94857DY91YGW
- parent_discount:
- description: The details of the parent discount that this discount was created from.
- x-expandable: parent_discount
- nullable: true
- type: object
- starts_at:
- description: The time at which the discount can be used.
- type: string
- format: date-time
- ends_at:
- description: The time at which the discount can no longer be used.
- nullable: true
- type: string
- format: date-time
- valid_duration:
- description: Duration the discount runs between
- nullable: true
- type: string
- example: P3Y6M4DT12H30M5S
- regions:
- description: The details of the regions in which the Discount can be used.
- type: array
- x-expandable: regions
- items:
- $ref: '#/components/schemas/Region'
- usage_limit:
- description: The maximum number of times that a discount can be used.
- nullable: true
- type: integer
- example: 100
- usage_count:
- description: The number of times a discount has been used.
- type: integer
- example: 50
- default: 0
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountCondition:
- title: Discount Condition
- description: Holds rule conditions for when a discount is applicable
- type: object
- required:
- - created_at
- - deleted_at
- - discount_rule_id
- - id
- - metadata
- - operator
- - type
- - updated_at
- properties:
- id:
- description: The discount condition's ID
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- type:
- description: The type of the condition. The type affects the available resources associated with the condition. For example, if the type is `products`, that means the `products` relation will hold the products associated with this condition and other relations will be empty.
- type: string
- enum:
- - products
- - product_types
- - product_collections
- - product_tags
- - customer_groups
- operator:
- description: The operator of the condition. `in` indicates that discountable resources are within the specified resources. `not_in` indicates that discountable resources are everything but the specified resources.
- type: string
- enum:
- - in
- - not_in
- discount_rule_id:
- description: The ID of the discount rule associated with the condition
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- discount_rule:
- description: The details of the discount rule associated with the condition.
- x-expandable: discount_rule
- nullable: true
- $ref: '#/components/schemas/DiscountRule'
+ title: region_id
+ description: The tax rate's region id.
+ rate:
+ type: number
+ title: rate
+ description: The tax rate's rate.
products:
- description: products associated with this condition if `type` is `products`.
type: array
- x-expandable: products
+ description: The tax rate's products.
items:
- $ref: '#/components/schemas/Product'
+ type: string
+ title: products
+ description: The product's products.
+ shipping_options:
+ type: array
+ description: The tax rate's shipping options.
+ items:
+ type: string
+ title: shipping_options
+ description: The shipping option's shipping options.
product_types:
- description: Product types associated with this condition if `type` is `product_types`.
type: array
- x-expandable: product_types
+ description: The tax rate's product types.
items:
- $ref: '#/components/schemas/ProductType'
- product_tags:
- description: Product tags associated with this condition if `type` is `product_tags`.
- type: array
- x-expandable: product_tags
- items:
- $ref: '#/components/schemas/ProductTag'
- product_collections:
- description: Product collections associated with this condition if `type` is `product_collections`.
- type: array
- x-expandable: product_collections
- items:
- $ref: '#/components/schemas/ProductCollection'
- customer_groups:
- description: Customer groups associated with this condition if `type` is `customer_groups`.
- type: array
- x-expandable: customer_groups
- items:
- $ref: '#/components/schemas/CustomerGroup'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountConditionCustomerGroup:
- title: Product Tag Discount Condition
- description: Associates a discount condition with a customer group
+ type: string
+ title: product_types
+ description: The product type's product types.
+ AdminPostTaxRatesTaxRateRulesReq:
type: object
+ description: SUMMARY
+ x-schemaName: AdminPostTaxRatesTaxRateRulesReq
required:
- - condition_id
- - created_at
- - customer_group_id
- - metadata
- - updated_at
+ - reference
+ - reference_id
properties:
- customer_group_id:
- description: The ID of the Product Tag
+ reference:
type: string
- example: cgrp_01G8ZH853Y6TFXWPG5EYE81X63
- condition_id:
- description: The ID of the Discount Condition
+ title: reference
+ description: The tax rate's reference.
+ reference_id:
type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- customer_group:
- description: Available if the relation `customer_group` is expanded.
- nullable: true
- $ref: '#/components/schemas/CustomerGroup'
- discount_condition:
- description: Available if the relation `discount_condition` is expanded.
- nullable: true
- $ref: '#/components/schemas/DiscountCondition'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountConditionProduct:
- title: Product Discount Condition
- description: This represents the association between a discount condition and a product
+ title: reference_id
+ description: The tax rate's reference id.
+ AdminPostTaxRegionsReq:
type: object
+ description: SUMMARY
+ x-schemaName: AdminPostTaxRegionsReq
required:
- - condition_id
- - created_at
- - metadata
- - product_id
- - updated_at
+ - country_code
properties:
- product_id:
- description: The ID of the Product Tag
+ country_code:
type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- condition_id:
- description: The ID of the Discount Condition
+ title: country_code
+ description: The tax region's country code.
+ province_code:
type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product:
- description: The details of the product.
- x-expandable: product
- nullable: true
- $ref: '#/components/schemas/Product'
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: '#/components/schemas/DiscountCondition'
- created_at:
- description: The date with timezone at which the resource was created.
+ title: province_code
+ description: The tax region's province code.
+ parent_id:
type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
+ title: parent_id
+ description: The tax region's parent id.
+ default_tax_rate:
+ $ref: '#/components/schemas/CreateDefaultTaxRate'
metadata:
- description: An optional key-value map with additional details
- nullable: true
type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountConditionProductCollection:
- title: Product Collection Discount Condition
- description: This represents the association between a discount condition and a product collection
+ description: The tax region's metadata.
+ properties: {}
+ AdminPostWorkflowsAsyncResponseReq:
type: object
+ description: SUMMARY
+ x-schemaName: AdminPostWorkflowsAsyncResponseReq
required:
- - condition_id
- - created_at
- - metadata
- - product_collection_id
- - updated_at
+ - transaction_id
+ - step_id
properties:
- product_collection_id:
- description: The ID of the Product Collection
+ transaction_id:
type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- condition_id:
- description: The ID of the Discount Condition
+ title: transaction_id
+ description: The workflows execution's transaction id.
+ step_id:
type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_collection:
- description: The details of the product collection.
- x-expandable: product_collection
- nullable: true
- $ref: '#/components/schemas/ProductCollection'
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: '#/components/schemas/DiscountCondition'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountConditionProductTag:
- title: Product Tag Discount Condition
- description: This represents the association between a discount condition and a product tag
+ title: step_id
+ description: The workflows execution's step id.
+ response: {}
+ compensate_input: {}
+ action: {}
+ AdminPostWorkflowsRunReq:
type: object
- required:
- - condition_id
- - created_at
- - metadata
- - product_tag_id
- - updated_at
+ description: SUMMARY
+ x-schemaName: AdminPostWorkflowsRunReq
properties:
- product_tag_id:
- description: The ID of the Product Tag
+ input: {}
+ transaction_id:
type: string
- example: ptag_01F0YESHPZYY3H4SJ3A5918SBN
- condition_id:
- description: The ID of the Discount Condition
- type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_tag:
- description: The details of the product tag.
- x-expandable: product_tag
- nullable: true
- $ref: '#/components/schemas/ProductTag'
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: '#/components/schemas/DiscountCondition'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountConditionProductType:
- title: Product Type Discount Condition
- description: This represents the association between a discount condition and a product type
+ title: transaction_id
+ description: The workflows execution's transaction id.
+ AdminUpdateUserRequest:
type: object
+ description: SUMMARY
+ x-schemaName: AdminUpdateUserRequest
required:
- - condition_id
- - created_at
- - metadata
- - product_type_id
- - updated_at
+ - avatar_url
properties:
- product_type_id:
- description: The ID of the Product Tag
+ first_name:
type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- condition_id:
- description: The ID of the Discount Condition
+ title: first_name
+ description: The user's first name.
+ last_name:
type: string
- example: discon_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_type:
- description: The details of the product type.
- x-expandable: product_type
- nullable: true
- $ref: '#/components/schemas/ProductType'
- discount_condition:
- description: The details of the discount condition.
- x-expandable: discount_condition
- nullable: true
- $ref: '#/components/schemas/DiscountCondition'
- created_at:
- description: The date with timezone at which the resource was created.
+ title: last_name
+ description: The user's last name.
+ avatar_url:
type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DiscountRule:
- title: Discount Rule
- description: A discount rule defines how a Discount is calculated when applied to a Cart.
+ title: avatar_url
+ description: The user's avatar url.
+ ApplicationMethodsMethodPostReq:
type: object
- required:
- - allocation
- - created_at
- - deleted_at
- - description
- - id
- - metadata
- - type
- - updated_at
- - value
+ description: The promotion's application method.
+ x-schemaName: ApplicationMethodsMethodPostReq
properties:
- id:
- description: The discount rule's ID
- type: string
- example: dru_01F0YESMVK96HVX7N419E3CJ7C
- type:
- description: The type of the Discount, can be `fixed` for discounts that reduce the price by a fixed amount, `percentage` for percentage reductions or `free_shipping` for shipping vouchers.
- type: string
- enum:
- - fixed
- - percentage
- - free_shipping
- example: percentage
description:
- description: A short description of the discount
- nullable: true
type: string
- example: 10 Percent
+ title: description
+ description: The application method's description.
value:
- description: The value that the discount represents; this will depend on the type of the discount
- type: integer
- example: 10
- allocation:
- description: The scope that the discount should apply to.
- nullable: true
type: string
- enum:
- - total
- - item
- example: total
- conditions:
- description: The details of the discount conditions associated with the rule. They can be used to limit when the discount can be used.
+ title: value
+ description: The application method's value.
+ max_quantity:
+ type: number
+ title: max_quantity
+ description: The application method's max quantity.
+ type: {}
+ target_type: {}
+ allocation: {}
+ target_rules:
type: array
- x-expandable: conditions
+ description: The application method's target rules.
items:
type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- DraftOrder:
- title: DraftOrder
- description: A draft order is created by an admin without direct involvement of the customer. Once its payment is marked as captured, it is transformed into an order.
+ description: The target rule's target rules.
+ x-schemaName: PromotionRule
+ required:
+ - operator
+ - attribute
+ - values
+ properties:
+ operator: {}
+ description:
+ type: string
+ title: description
+ description: The target rule's description.
+ attribute:
+ type: string
+ title: attribute
+ description: The target rule's attribute.
+ values:
+ type: array
+ description: The target rule's values.
+ items:
+ type: string
+ title: values
+ description: The value's values.
+ buy_rules:
+ type: array
+ description: The application method's buy rules.
+ items:
+ type: object
+ description: The buy rule's buy rules.
+ x-schemaName: PromotionRule
+ required:
+ - operator
+ - attribute
+ - values
+ properties:
+ operator: {}
+ description:
+ type: string
+ title: description
+ description: The buy rule's description.
+ attribute:
+ type: string
+ title: attribute
+ description: The buy rule's attribute.
+ values:
+ type: array
+ description: The buy rule's values.
+ items:
+ type: string
+ title: values
+ description: The value's values.
+ apply_to_quantity:
+ type: number
+ title: apply_to_quantity
+ description: The application method's apply to quantity.
+ buy_rules_min_quantity:
+ type: number
+ title: buy_rules_min_quantity
+ description: The application method's buy rules min quantity.
+ CampaignBudget:
type: object
- required:
- - canceled_at
- - cart_id
- - completed_at
- - created_at
- - display_id
- - id
- - idempotency_key
- - metadata
- - no_notification_order
- - order_id
- - status
- - updated_at
+ description: The campaign's budget.
+ x-schemaName: CampaignBudget
properties:
- id:
- description: The draft order's ID
+ type: {}
+ limit:
+ type: number
+ title: limit
+ description: The budget's limit.
+ CreateDefaultTaxRate:
+ type: object
+ description: The tax region's default tax rate.
+ x-schemaName: CreateDefaultTaxRate
+ required:
+ - name
+ properties:
+ rate:
+ type: number
+ title: rate
+ description: The default tax rate's rate.
+ code:
type: string
- example: dorder_01G8TJFKBG38YYFQ035MSVG03C
- status:
- description: The status of the draft order. It's changed to `completed` when it's transformed to an order.
+ title: code
+ description: The default tax rate's code.
+ name:
type: string
- enum:
- - open
- - completed
- default: open
- display_id:
- description: The draft order's display ID
- type: string
- example: 2
- cart_id:
- description: The ID of the cart associated with the draft order.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart associated with the draft order.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order created from the draft order when its payment is captured.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order created from the draft order when its payment is captured.
- x-expandable: order
- nullable: true
- type: object
- canceled_at:
- description: The date the draft order was canceled at.
- nullable: true
- type: string
- format: date-time
- completed_at:
- description: The date the draft order was completed at.
- nullable: true
- type: string
- format: date-time
- no_notification_order:
- description: Whether to send the customer notifications regarding order updates.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: Randomly generated key used to continue the completion of the cart associated with the draft order in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
+ title: name
+ description: The default tax rate's name.
metadata:
- description: An optional key-value map with additional details
- nullable: true
type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
+ description: The default tax rate's metadata.
+ properties: {}
Error:
title: Response Error
type: object
@@ -8126,1078 +2918,6 @@ components:
- unexpected_state
- invalid_argument
- unknown_error
- ExtendedStoreDTO:
- allOf:
- - $ref: '#/components/schemas/Store'
- - type: object
- required:
- - payment_providers
- - fulfillment_providers
- - feature_flags
- - modules
- properties:
- payment_providers:
- description: The store's payment providers.
- $ref: '#/components/schemas/PaymentProvider'
- fulfillment_providers:
- description: The store's fulfillment providers.
- $ref: '#/components/schemas/FulfillmentProvider'
- feature_flags:
- description: The feature flags enabled in the store's backend.
- $ref: '#/components/schemas/FeatureFlagsResponse'
- modules:
- description: The modules installed in the store's backend.
- $ref: '#/components/schemas/ModulesResponse'
- FeatureFlagsResponse:
- type: array
- items:
- type: object
- required:
- - key
- - value
- properties:
- key:
- description: The key of the feature flag.
- type: string
- value:
- description: The value of the feature flag.
- type: boolean
- Fulfillment:
- title: Fulfillment
- description: A Fulfillment is created once an admin can prepare the purchased goods. Fulfillments will eventually be shipped and hold information about how to track shipments. Fulfillments are created through a fulfillment provider, which typically integrates a third-party shipping service. Fulfillments can be associated with orders, claims, swaps, and returns.
- type: object
- required:
- - canceled_at
- - claim_order_id
- - created_at
- - data
- - id
- - idempotency_key
- - location_id
- - metadata
- - no_notification
- - order_id
- - provider_id
- - shipped_at
- - swap_id
- - tracking_numbers
- - updated_at
- properties:
- id:
- description: The fulfillment's ID
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- claim_order_id:
- description: The ID of the Claim that the Fulfillment belongs to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the fulfillment may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- swap_id:
- description: The ID of the Swap that the Fulfillment belongs to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the fulfillment may belong to.
- x-expandable: swap
- nullable: true
- type: object
- order_id:
- description: The ID of the Order that the Fulfillment belongs to.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the fulfillment may belong to.
- x-expandable: order
- nullable: true
- type: object
- provider_id:
- description: The ID of the Fulfillment Provider responsible for handling the fulfillment.
- type: string
- example: manual
- provider:
- description: The details of the fulfillment provider responsible for handling the fulfillment.
- x-expandable: provider
- nullable: true
- $ref: '#/components/schemas/FulfillmentProvider'
- location_id:
- description: The ID of the stock location the fulfillment will be shipped from
- nullable: true
- type: string
- example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
- items:
- description: The Fulfillment Items in the Fulfillment. These hold information about how many of each Line Item has been fulfilled.
- type: array
- x-expandable: items
- items:
- $ref: '#/components/schemas/FulfillmentItem'
- tracking_links:
- description: The Tracking Links that can be used to track the status of the Fulfillment. These will usually be provided by the Fulfillment Provider.
- type: array
- x-expandable: tracking_links
- items:
- $ref: '#/components/schemas/TrackingLink'
- tracking_numbers:
- description: The tracking numbers that can be used to track the status of the fulfillment.
- deprecated: true
- type: array
- items:
- type: string
- data:
- description: This contains all the data necessary for the Fulfillment provider to handle the fulfillment.
- type: object
- example: {}
- shipped_at:
- description: The date with timezone at which the Fulfillment was shipped.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: Flag for describing whether or not notifications related to this should be sent.
- nullable: true
- type: boolean
- example: false
- canceled_at:
- description: The date with timezone at which the Fulfillment was canceled.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: Randomly generated key used to continue the completion of the fulfillment in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- FulfillmentItem:
- title: Fulfillment Item
- description: This represents the association between a Line Item and a Fulfillment.
- type: object
- required:
- - fulfillment_id
- - item_id
- - quantity
- properties:
- fulfillment_id:
- description: The ID of the Fulfillment that the Fulfillment Item belongs to.
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- item_id:
- description: The ID of the Line Item that the Fulfillment Item references.
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- fulfillment:
- description: The details of the fulfillment.
- x-expandable: fulfillment
- nullable: true
- type: object
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- $ref: '#/components/schemas/LineItem'
- quantity:
- description: The quantity of the Line Item that is included in the Fulfillment.
- type: integer
- example: 1
- FulfillmentProvider:
- title: Fulfillment Provider
- description: A fulfillment provider represents a fulfillment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the fulfillment service's installation status.
- type: object
- required:
- - id
- - is_installed
- properties:
- id:
- description: The ID of the fulfillment provider as given by the fulfillment service.
- type: string
- example: manual
- is_installed:
- description: Whether the fulfillment service is installed in the current version. If a fulfillment service is no longer installed, the `is_installed` attribute is set to `false`.
- type: boolean
- default: true
- GiftCard:
- title: Gift Card
- description: Gift Cards are redeemable and represent a value that can be used towards the payment of an Order.
- type: object
- required:
- - balance
- - code
- - created_at
- - deleted_at
- - ends_at
- - id
- - is_disabled
- - metadata
- - order_id
- - region_id
- - tax_rate
- - updated_at
- - value
- properties:
- id:
- description: The gift card's ID
- type: string
- example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
- code:
- description: The unique code that identifies the Gift Card. This is used by the Customer to redeem the value of the Gift Card.
- type: string
- example: 3RFT-MH2C-Y4YZ-XMN4
- value:
- description: The value that the Gift Card represents.
- type: integer
- example: 10
- balance:
- description: The remaining value on the Gift Card.
- type: integer
- example: 10
- region_id:
- description: The ID of the region this gift card is available in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this gift card is available in.
- x-expandable: region
- nullable: true
- $ref: '#/components/schemas/Region'
- order_id:
- description: The ID of the order that the gift card was purchased in.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the gift card was purchased in.
- x-expandable: region
- nullable: true
- type: object
- is_disabled:
- description: Whether the Gift Card has been disabled. Disabled Gift Cards cannot be applied to carts.
- type: boolean
- default: false
- ends_at:
- description: The time at which the Gift Card can no longer be used.
- nullable: true
- type: string
- format: date-time
- tax_rate:
- description: The gift card's tax rate that will be applied on calculating totals
- nullable: true
- type: number
- example: 0
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- GiftCardTransaction:
- title: Gift Card Transaction
- description: Gift Card Transactions are created once a Customer uses a Gift Card to pay for their Order.
- type: object
- required:
- - amount
- - created_at
- - gift_card_id
- - id
- - is_taxable
- - order_id
- - tax_rate
- properties:
- id:
- description: The gift card transaction's ID
- type: string
- example: gct_01G8X9A7ESKAJXG2H0E6F1MW7A
- gift_card_id:
- description: The ID of the Gift Card that was used in the transaction.
- type: string
- example: gift_01G8XKBPBQY2R7RBET4J7E0XQZ
- gift_card:
- description: The details of the gift card associated used in this transaction.
- x-expandable: gift_card
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the gift card was used for payment.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the gift card was used for payment.
- x-expandable: order
- nullable: true
- type: object
- amount:
- description: The amount that was used from the Gift Card.
- type: integer
- example: 10
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- is_taxable:
- description: Whether the transaction is taxable or not.
- nullable: true
- type: boolean
- example: false
- tax_rate:
- description: The tax rate of the transaction
- nullable: true
- type: number
- example: 0
- IdempotencyKey:
- title: Idempotency Key
- description: Idempotency Key is used to continue a process in case of any failure that might occur.
- type: object
- required:
- - created_at
- - id
- - idempotency_key
- - locked_at
- - recovery_point
- - response_code
- - response_body
- - request_method
- - request_params
- - request_path
- properties:
- id:
- description: The idempotency key's ID
- type: string
- example: ikey_01G8X9A7ESKAJXG2H0E6F1MW7A
- idempotency_key:
- description: The unique randomly generated key used to determine the state of a process.
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: Date which the idempotency key was locked.
- type: string
- format: date-time
- locked_at:
- description: Date which the idempotency key was locked.
- nullable: true
- type: string
- format: date-time
- request_method:
- description: The method of the request
- nullable: true
- type: string
- example: POST
- request_params:
- description: The parameters passed to the request
- nullable: true
- type: object
- example:
- id: cart_01G8ZH853Y6TFXWPG5EYE81X63
- request_path:
- description: The request's path
- nullable: true
- type: string
- example: /store/carts/cart_01G8ZH853Y6TFXWPG5EYE81X63/complete
- response_code:
- description: The response's code.
- nullable: true
- type: string
- example: 200
- response_body:
- description: The response's body
- nullable: true
- type: object
- example:
- id: cart_01G8ZH853Y6TFXWPG5EYE81X63
- recovery_point:
- description: Where to continue from.
- type: string
- default: started
- Image:
- title: Image
- description: An Image is used to store details about uploaded images. Images are uploaded by the File Service, and the URL is provided by the File Service.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - url
- properties:
- id:
- type: string
- description: The image's ID
- example: img_01G749BFYR6T8JTVW6SGW3K3E6
- url:
- description: The URL at which the image file can be found.
- type: string
- format: uri
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- InventoryItemDTO:
- type: object
- required:
- - sku
- properties:
- id:
- description: The inventory item's ID.
- type: string
- example: iitem_12334
- sku:
- description: The Stock Keeping Unit (SKU) code of the Inventory Item.
- type: string
- hs_code:
- description: The Harmonized System code of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- origin_country:
- description: The country in which the Inventory Item was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- mid_code:
- description: The Manufacturers Identification code that identifies the manufacturer of the Inventory Item. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- title:
- description: Title of the inventory item
- type: string
- description:
- description: Description of the inventory item
- type: string
- thumbnail:
- description: Thumbnail for the inventory item
- type: string
- material:
- description: The material and composition that the Inventory Item is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
- type: string
- weight:
- description: The weight of the Inventory Item. May be used in shipping rate calculations.
- type: number
- height:
- description: The height of the Inventory Item. May be used in shipping rate calculations.
- type: number
- width:
- description: The width of the Inventory Item. May be used in shipping rate calculations.
- type: number
- length:
- description: The length of the Inventory Item. May be used in shipping rate calculations.
- type: number
- requires_shipping:
- description: Whether the item requires shipping.
- type: boolean
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- InventoryLevelDTO:
- type: object
- required:
- - inventory_item_id
- - location_id
- - stocked_quantity
- - reserved_quantity
- - incoming_quantity
- properties:
- location_id:
- description: the item location ID
- type: string
- stocked_quantity:
- description: the total stock quantity of an inventory item at the given location ID
- type: number
- reserved_quantity:
- description: the reserved stock quantity of an inventory item at the given location ID
- type: number
- incoming_quantity:
- description: the incoming stock quantity of an inventory item at the given location ID
- type: number
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- Invite:
- title: Invite
- description: An invite is created when an admin user invites a new user to join the store's team. Once the invite is accepted, it's deleted.
- type: object
- required:
- - accepted
- - created_at
- - deleted_at
- - expires_at
- - id
- - metadata
- - role
- - token
- - updated_at
- - user_email
- properties:
- id:
- type: string
- description: The invite's ID
- example: invite_01G8TKE4XYCTHSCK2GDEP47RE1
- user_email:
- description: The email of the user being invited.
- type: string
- format: email
- role:
- description: The user's role. These roles don't change the privileges of the user.
- nullable: true
- type: string
- enum:
- - admin
- - member
- - developer
- default: member
- accepted:
- description: Whether the invite was accepted or not.
- type: boolean
- default: false
- token:
- description: The token used to accept the invite.
- type: string
- expires_at:
- description: The date the invite expires at.
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- LineItem:
- title: Line Item
- description: Line Items are created when a product is added to a Cart. When Line Items are purchased they will get copied to the resulting order, swap, or claim, and can eventually be referenced in Fulfillments and Returns. Line items may also be used for order edits.
- type: object
- required:
- - allow_discounts
- - cart_id
- - claim_order_id
- - created_at
- - description
- - fulfilled_quantity
- - has_shipping
- - id
- - is_giftcard
- - is_return
- - metadata
- - order_edit_id
- - order_id
- - original_item_id
- - quantity
- - returned_quantity
- - shipped_quantity
- - should_merge
- - swap_id
- - thumbnail
- - title
- - unit_price
- - updated_at
- - variant_id
- properties:
- id:
- description: The line item's ID
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- cart_id:
- description: The ID of the cart that the line item may belongs to.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the line item may belongs to.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the line item may belongs to.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the line item may belongs to.
- x-expandable: order
- nullable: true
- type: object
- swap_id:
- description: The ID of the swap that the line item may belong to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the line item may belong to.
- x-expandable: swap
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the line item may belong to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the line item may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- tax_lines:
- description: The details of the item's tax lines.
- x-expandable: tax_lines
- type: array
- items:
- $ref: '#/components/schemas/LineItemTaxLine'
- adjustments:
- description: The details of the item's adjustments, which are available when a discount is applied on the item.
- x-expandable: adjustments
- type: array
- items:
- $ref: '#/components/schemas/LineItemAdjustment'
- original_item_id:
- description: The ID of the original line item. This is useful if the line item belongs to a resource that references an order, such as a return or an order edit.
- nullable: true
- type: string
- order_edit_id:
- description: The ID of the order edit that the item may belong to.
- nullable: true
- type: string
- order_edit:
- description: The details of the order edit.
- x-expandable: order_edit
- nullable: true
- type: object
- title:
- description: The title of the Line Item.
- type: string
- example: Medusa Coffee Mug
- description:
- description: A more detailed description of the contents of the Line Item.
- nullable: true
- type: string
- example: One Size
- thumbnail:
- description: A URL string to a small image of the contents of the Line Item.
- nullable: true
- type: string
- format: uri
- example: https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png
- is_return:
- description: Is the item being returned
- type: boolean
- default: false
- is_giftcard:
- description: Flag to indicate if the Line Item is a Gift Card.
- type: boolean
- default: false
- should_merge:
- description: Flag to indicate if new Line Items with the same variant should be merged or added as an additional Line Item.
- type: boolean
- default: true
- allow_discounts:
- description: Flag to indicate if the Line Item should be included when doing discount calculations.
- type: boolean
- default: true
- has_shipping:
- description: Flag to indicate if the Line Item has fulfillment associated with it.
- nullable: true
- type: boolean
- example: false
- unit_price:
- description: The price of one unit of the content in the Line Item. This should be in the currency defined by the Cart/Order/Swap/Claim that the Line Item belongs to.
- type: integer
- example: 8000
- variant_id:
- description: The id of the Product Variant contained in the Line Item.
- nullable: true
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that this item was created from.
- x-expandable: variant
- nullable: true
- $ref: '#/components/schemas/ProductVariant'
- quantity:
- description: The quantity of the content in the Line Item.
- type: integer
- example: 1
- fulfilled_quantity:
- description: The quantity of the Line Item that has been fulfilled.
- nullable: true
- type: integer
- example: 0
- returned_quantity:
- description: The quantity of the Line Item that has been returned.
- nullable: true
- type: integer
- example: 0
- shipped_quantity:
- description: The quantity of the Line Item that has been shipped.
- nullable: true
- type: integer
- example: 0
- refundable:
- description: The amount that can be refunded from the given Line Item. Takes taxes and discounts into consideration.
- type: integer
- example: 0
- subtotal:
- description: The subtotal of the line item
- type: integer
- example: 8000
- tax_total:
- description: The total of tax of the line item
- type: integer
- example: 0
- total:
- description: The total amount of the line item
- type: integer
- example: 8000
- original_total:
- description: The original total amount of the line item
- type: integer
- example: 8000
- original_tax_total:
- description: The original tax total amount of the line item
- type: integer
- example: 0
- discount_total:
- description: The total of discount of the line item rounded
- type: integer
- example: 0
- raw_discount_total:
- description: The total of discount of the line item
- type: integer
- example: 0
- gift_card_total:
- description: The total of the gift card of the line item
- type: integer
- example: 0
- includes_tax:
- description: Indicates if the line item unit_price include tax
- x-featureFlag: tax_inclusive_pricing
- type: boolean
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- LineItemAdjustment:
- title: Line Item Adjustment
- description: A Line Item Adjustment includes details on discounts applied on a line item.
- type: object
- required:
- - amount
- - description
- - discount_id
- - id
- - item_id
- - metadata
- properties:
- id:
- description: The Line Item Adjustment's ID
- type: string
- example: lia_01G8TKE4XYCTHSCK2GDEP47RE1
- item_id:
- description: The ID of the line item
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- type: object
- description:
- description: The line item's adjustment description
- type: string
- example: Adjusted item's price.
- discount_id:
- description: The ID of the discount associated with the adjustment
- nullable: true
- type: string
- example: disc_01F0YESMW10MGHWJKZSDDMN0VN
- discount:
- description: The details of the discount associated with the adjustment.
- x-expandable: discount
- nullable: true
- $ref: '#/components/schemas/Discount'
- amount:
- description: The adjustment amount
- type: number
- example: 1000
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- LineItemTaxLine:
- title: Line Item Tax Line
- description: A Line Item Tax Line represents the taxes applied on a line item.
- type: object
- required:
- - code
- - created_at
- - id
- - item_id
- - metadata
- - name
- - rate
- - updated_at
- properties:
- id:
- description: The line item tax line's ID
- type: string
- example: litl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- item_id:
- description: The ID of the line item
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- item:
- description: The details of the line item.
- x-expandable: item
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ModulesResponse:
- type: array
- items:
- type: object
- required:
- - module
- - resolution
- properties:
- module:
- description: The key of the module.
- type: string
- resolution:
- description: The resolution path of the module or false if module is not installed.
- type: string
- MoneyAmount:
- title: Money Amount
- description: A Money Amount represent a price amount, for example, a product variant's price or a price in a price list. Each Money Amount either has a Currency or Region associated with it to indicate the pricing in a given Currency or, for fully region-based pricing, the given price in a specific Region. If region-based pricing is used, the amount will be in the currency defined for the Region.
- type: object
- required:
- - amount
- - created_at
- - currency_code
- - deleted_at
- - id
- - max_quantity
- - min_quantity
- - price_list_id
- - region_id
- - updated_at
- - variant_id
- properties:
- id:
- description: The money amount's ID
- type: string
- example: ma_01F0YESHRFQNH5S8Q0PK84YYZN
- currency_code:
- description: The 3 character currency code that the money amount may belong to.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency that the money amount may belong to.
- x-expandable: currency
- nullable: true
- $ref: '#/components/schemas/Currency'
- amount:
- description: The amount in the smallest currecny unit (e.g. cents 100 cents to charge $1) that the Product Variant will cost.
- type: integer
- example: 100
- min_quantity:
- description: The minimum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.
- nullable: true
- type: integer
- example: 1
- max_quantity:
- description: The maximum quantity that the Money Amount applies to. If this value is not set, the Money Amount applies to all quantities.
- nullable: true
- type: integer
- example: 1
- price_list_id:
- description: The ID of the price list that the money amount may belong to.
- nullable: true
- type: string
- example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
- price_list:
- description: The details of the price list that the money amount may belong to.
- x-expandable: price_list
- nullable: true
- type: object
- variant_id:
- description: The ID of the Product Variant contained in the Line Item.
- nullable: true
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that the money amount may belong to.
- x-expandable: variant
- nullable: true
- type: object
- region_id:
- description: The region's ID
- nullable: true
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region that the money amount may belong to.
- x-expandable: region
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
MultipleErrors:
title: Multiple Errors
type: object
@@ -9210,5266 +2930,64 @@ components:
message:
type: string
default: Provided request body contains errors. Please check the data and retry the request
- Note:
- title: Note
- description: A Note is an element that can be used in association with different resources to allow admin users to describe additional information. For example, they can be used to add additional information about orders.
- type: object
- required:
- - author_id
- - created_at
- - deleted_at
- - id
- - metadata
- - resource_id
- - resource_type
- - updated_at
- - value
- properties:
- id:
- description: The note's ID
- type: string
- example: note_01G8TM8ENBMC7R90XRR1G6H26Q
- resource_type:
- description: The type of resource that the Note refers to.
- type: string
- example: order
- resource_id:
- description: The ID of the resource that the Note refers to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- value:
- description: The contents of the note.
- type: string
- example: This order must be fulfilled on Monday
- author_id:
- description: The ID of the user that created the note.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- author:
- description: The details of the user that created the note.
- x-expandable: author
- nullable: true
- $ref: '#/components/schemas/User'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- Notification:
- title: Notification
- description: A notification is an alert sent, typically to customers, using the installed Notification Provider as a reaction to internal events such as `order.placed`. Notifications can be resent.
- type: object
- required:
- - created_at
- - customer_id
- - data
- - event_name
- - id
- - parent_id
- - provider_id
- - resource_type
- - resource_id
- - to
- - updated_at
- properties:
- id:
- description: The notification's ID
- type: string
- example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
- event_name:
- description: The name of the event that the notification was sent for.
- nullable: true
- type: string
- example: order.placed
- resource_type:
- description: The type of resource that the Notification refers to.
- type: string
- example: order
- resource_id:
- description: The ID of the resource that the Notification refers to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- customer_id:
- description: The ID of the customer that this notification was sent to.
- nullable: true
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer that this notification was sent to.
- x-expandable: customer
- nullable: true
- $ref: '#/components/schemas/Customer'
- to:
- description: The address that the Notification was sent to. This will usually be an email address, but can represent other addresses such as a chat bot user ID.
- type: string
- example: user@example.com
- data:
- description: The data that the Notification was sent with. This contains all the data necessary for the Notification Provider to initiate a resend.
- type: object
- example: {}
- parent_id:
- description: The notification's parent ID
- nullable: true
- type: string
- example: noti_01G53V9Y6CKMCGBM1P0X7C28RX
- parent_notification:
- description: The details of the parent notification.
- x-expandable: parent_notification
- nullable: true
- type: object
- resends:
- description: The details of all resends of the notification.
- type: array
- x-expandable: resends
- items:
- type: object
- provider_id:
- description: The ID of the notification provider used to send the notification.
- nullable: true
- type: string
- example: sengrid
- provider:
- description: The notification provider used to send the notification.
- x-expandable: provider
- nullable: true
- $ref: '#/components/schemas/NotificationProvider'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- NotificationProvider:
- title: Notification Provider
- description: A notification provider represents a notification service installed in the Medusa backend, either through a plugin or backend customizations. It holds the notification service's installation status.
- type: object
- required:
- - id
- - is_installed
- properties:
- id:
- description: The ID of the notification provider as given by the notification service.
- type: string
- example: sendgrid
- is_installed:
- description: Whether the notification service is installed in the current version. If a notification service is no longer installed, the `is_installed` attribute is set to `false`.
- type: boolean
- default: true
- OAuth:
- title: OAuth
- description: An Oauth app is typically created by a plugin to handle authentication to third-party services.
- type: object
- required:
- - application_name
- - data
- - display_name
- - id
- - install_url
- - uninstall_url
- properties:
- id:
- description: The app's ID
- type: string
- example: example_app
- display_name:
- description: The app's display name
- type: string
- example: Example app
- application_name:
- description: The app's name
- type: string
- example: example
- install_url:
- description: The URL to install the app
- nullable: true
- type: string
- format: uri
- uninstall_url:
- description: The URL to uninstall the app
- nullable: true
- type: string
- format: uri
- data:
- description: Any data necessary to the app.
- nullable: true
- type: object
- example: {}
- Order:
- title: Order
- description: An order is a purchase made by a customer. It holds details about payment and fulfillment of the order. An order may also be created from a draft order, which is created by an admin user.
- type: object
- required:
- - billing_address_id
- - canceled_at
- - cart_id
- - created_at
- - currency_code
- - customer_id
- - draft_order_id
- - display_id
- - email
- - external_id
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - object
- - payment_status
- - region_id
- - shipping_address_id
- - status
- - tax_rate
- - updated_at
- properties:
- id:
- description: The order's ID
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- status:
- description: The order's status
- type: string
- enum:
- - pending
- - completed
- - archived
- - canceled
- - requires_action
- default: pending
- fulfillment_status:
- description: The order's fulfillment status
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- default: not_fulfilled
- payment_status:
- description: The order's payment status
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - partially_refunded
- - refunded
- - canceled
- - requires_action
- default: not_paid
- display_id:
- description: The order's display ID
- type: integer
- example: 2
- cart_id:
- description: The ID of the cart associated with the order
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart associated with the order.
- x-expandable: cart
- nullable: true
- type: object
- customer_id:
- description: The ID of the customer associated with the order
- type: string
- example: cus_01G2SG30J8C85S4A5CHM2S1NS2
- customer:
- description: The details of the customer associated with the order.
- x-expandable: customer
- nullable: true
- type: object
- email:
- description: The email associated with the order
- type: string
- format: email
- billing_address_id:
- description: The ID of the billing address associated with the order
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- billing_address:
- description: The details of the billing address associated with the order.
- x-expandable: billing_address
- nullable: true
- $ref: '#/components/schemas/Address'
- shipping_address_id:
- description: The ID of the shipping address associated with the order
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address associated with the order.
- x-expandable: shipping_address
- nullable: true
- $ref: '#/components/schemas/Address'
- region_id:
- description: The ID of the region this order was created in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this order was created in.
- x-expandable: region
- nullable: true
- $ref: '#/components/schemas/Region'
- currency_code:
- description: The 3 character currency code that is used in the order
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency used in the order.
- x-expandable: currency
- nullable: true
- $ref: '#/components/schemas/Currency'
- tax_rate:
- description: The order's tax rate
- nullable: true
- type: number
- example: 0
- discounts:
- description: The details of the discounts applied on the order.
- type: array
- x-expandable: discounts
- items:
- $ref: '#/components/schemas/Discount'
- gift_cards:
- description: The details of the gift card used in the order.
- type: array
- x-expandable: gift_cards
- items:
- $ref: '#/components/schemas/GiftCard'
- shipping_methods:
- description: The details of the shipping methods used in the order.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: '#/components/schemas/ShippingMethod'
- payments:
- description: The details of the payments used in the order.
- type: array
- x-expandable: payments
- items:
- type: object
- fulfillments:
- description: The details of the fulfillments created for the order.
- type: array
- x-expandable: fulfillments
- items:
- type: object
- returns:
- description: The details of the returns created for the order.
- type: array
- x-expandable: returns
- items:
- type: object
- claims:
- description: The details of the claims created for the order.
- type: array
- x-expandable: claims
- items:
- type: object
- refunds:
- description: The details of the refunds created for the order.
- type: array
- x-expandable: refunds
- items:
- type: object
- swaps:
- description: The details of the swaps created for the order.
- type: array
- x-expandable: swaps
- items:
- type: object
- draft_order_id:
- description: The ID of the draft order this order was created from.
- nullable: true
- type: string
- example: null
- draft_order:
- description: The details of the draft order this order was created from.
- x-expandable: draft_order
- nullable: true
- type: object
- items:
- description: The details of the line items that belong to the order.
- x-expandable: items
- type: array
- items:
- $ref: '#/components/schemas/LineItem'
- edits:
- description: The details of the order edits done on the order.
- type: array
- x-expandable: edits
- items:
- type: object
- gift_card_transactions:
- description: The gift card transactions made in the order.
- type: array
- x-expandable: gift_card_transactions
- items:
- $ref: '#/components/schemas/GiftCardTransaction'
- canceled_at:
- description: The date the order was canceled on.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: Flag for describing whether or not notifications related to this should be send.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: Randomly generated key used to continue the processing of the order in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- external_id:
- description: The ID of an external order.
- nullable: true
- type: string
- example: null
- sales_channel_id:
- description: The ID of the sales channel this order belongs to.
- nullable: true
- type: string
- example: null
- sales_channel:
- description: The details of the sales channel this order belongs to.
- x-expandable: sales_channel
- nullable: true
- $ref: '#/components/schemas/SalesChannel'
- shipping_total:
- type: integer
- description: The total of shipping
- example: 1000
- nullable: true
- shipping_tax_total:
- type: integer
- description: The tax total applied on shipping
- example: 1000
- raw_discount_total:
- description: The total of discount
- type: integer
- example: 800
- discount_total:
- description: The total of discount rounded
- type: integer
- example: 800
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- item_tax_total:
- description: The tax total applied on items
- type: integer
- example: 0
- nullable: true
- refunded_total:
- description: The total amount refunded if the order is returned.
- type: integer
- example: 0
- total:
- description: The total amount of the order
- type: integer
- example: 8200
- subtotal:
- description: The subtotal of the order
- type: integer
- example: 8000
- paid_total:
- description: The total amount paid
- type: integer
- example: 8000
- refundable_amount:
- description: The amount that can be refunded
- type: integer
- example: 8200
- gift_card_total:
- description: The total of gift cards
- type: integer
- example: 0
- gift_card_tax_total:
- description: The total of gift cards with taxes
- type: integer
- example: 0
- returnable_items:
- description: The details of the line items that are returnable as part of the order, swaps, or claims
- type: array
- x-expandable: returnable_items
- items:
- $ref: '#/components/schemas/LineItem'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- sales_channels:
- description: The associated sales channels.
- type: array
- nullable: true
- x-expandable: sales_channels
- x-featureFlag: medusa_v2
- items:
- $ref: '#/components/schemas/SalesChannel'
- OrderEdit:
- title: Order Edit
- description: Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.
- type: object
- required:
- - canceled_at
- - canceled_by
- - confirmed_by
- - confirmed_at
- - created_at
- - created_by
- - declined_at
- - declined_by
- - declined_reason
- - id
- - internal_note
- - order_id
- - payment_collection_id
- - requested_at
- - requested_by
- - status
- - updated_at
- properties:
- id:
- description: The order edit's ID
- type: string
- example: oe_01G8TJSYT9M6AVS5N4EMNFS1EK
- order_id:
- description: The ID of the order that is edited
- type: string
- example: order_01G2SG30J8C85S4A5CHM2S1NS2
- order:
- description: The details of the order that this order edit was created for.
- x-expandable: order
- nullable: true
- type: object
- changes:
- description: The details of all the changes on the original order's line items.
- x-expandable: changes
- type: array
- items:
- $ref: '#/components/schemas/OrderItemChange'
- internal_note:
- description: An optional note with additional details about the order edit.
- nullable: true
- type: string
- example: Included two more items B to the order.
- created_by:
- description: The unique identifier of the user or customer who created the order edit.
- type: string
- requested_by:
- description: The unique identifier of the user or customer who requested the order edit.
- nullable: true
- type: string
- requested_at:
- description: The date with timezone at which the edit was requested.
- nullable: true
- type: string
- format: date-time
- confirmed_by:
- description: The unique identifier of the user or customer who confirmed the order edit.
- nullable: true
- type: string
- confirmed_at:
- description: The date with timezone at which the edit was confirmed.
- nullable: true
- type: string
- format: date-time
- declined_by:
- description: The unique identifier of the user or customer who declined the order edit.
- nullable: true
- type: string
- declined_at:
- description: The date with timezone at which the edit was declined.
- nullable: true
- type: string
- format: date-time
- declined_reason:
- description: An optional note why the order edit is declined.
- nullable: true
- type: string
- canceled_by:
- description: The unique identifier of the user or customer who cancelled the order edit.
- nullable: true
- type: string
- canceled_at:
- description: The date with timezone at which the edit was cancelled.
- nullable: true
- type: string
- format: date-time
- subtotal:
- description: The total of subtotal
- type: integer
- example: 8000
- discount_total:
- description: The total of discount
- type: integer
- example: 800
- shipping_total:
- description: The total of the shipping amount
- type: integer
- example: 800
- gift_card_total:
- description: The total of the gift card amount
- type: integer
- example: 800
- gift_card_tax_total:
- description: The total of the gift card tax amount
- type: integer
- example: 800
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- total:
- description: The total amount of the edited order.
- type: integer
- example: 8200
- difference_due:
- description: The difference between the total amount of the order and total amount of edited order.
- type: integer
- example: 8200
- status:
- description: The status of the order edit.
- type: string
- enum:
- - confirmed
- - declined
- - requested
- - created
- - canceled
- items:
- description: The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.
- type: array
- x-expandable: items
- items:
- $ref: '#/components/schemas/LineItem'
- payment_collection_id:
- description: The ID of the payment collection
- nullable: true
- type: string
- example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
- payment_collection:
- description: The details of the payment collection used to authorize additional payment if necessary.
- x-expandable: payment_collection
- nullable: true
- $ref: '#/components/schemas/PaymentCollection'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- OrderItemChange:
- title: Order Item Change
- description: An order item change is a change made within an order edit to an order's items. These changes are not reflected on the original order until the order edit is confirmed.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - line_item_id
- - order_edit_id
- - original_line_item_id
- - type
- - updated_at
- properties:
- id:
- description: The order item change's ID
- type: string
- example: oic_01G8TJSYT9M6AVS5N4EMNFS1EK
- type:
- description: The order item change's status
- type: string
- enum:
- - item_add
- - item_remove
- - item_update
- order_edit_id:
- description: The ID of the order edit
- type: string
- example: oe_01G2SG30J8C85S4A5CHM2S1NS2
- order_edit:
- description: The details of the order edit the item change is associated with.
- x-expandable: order_edit
- nullable: true
- type: object
- original_line_item_id:
- description: The ID of the original line item in the order
- nullable: true
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- original_line_item:
- description: The details of the original line item this item change references. This is used if the item change updates or deletes the original item.
- x-expandable: original_line_item
- nullable: true
- $ref: '#/components/schemas/LineItem'
- line_item_id:
- description: The ID of the cloned line item.
- nullable: true
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- line_item:
- description: The details of the resulting line item after the item change. This line item is then used in the original order once the order edit is confirmed.
- x-expandable: line_item
- nullable: true
- $ref: '#/components/schemas/LineItem'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- Payment:
- title: Payment
- description: A payment is originally created from a payment session. Once a payment session is authorized, the payment is created to represent the authorized amount with a given payment method. Payments can be captured, canceled or refunded. Payments can be made towards orders, swaps, order edits, or other resources.
- type: object
- required:
- - amount
- - amount_refunded
- - canceled_at
- - captured_at
- - cart_id
- - created_at
- - currency_code
- - data
- - id
- - idempotency_key
- - metadata
- - order_id
- - provider_id
- - swap_id
- - updated_at
- properties:
- id:
- description: The payment's ID
- type: string
- example: pay_01G2SJNT6DEEWDFNAJ4XWDTHKE
- swap_id:
- description: The ID of the swap that this payment was potentially created for.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that this payment was potentially created for.
- x-expandable: swap
- nullable: true
- type: object
- cart_id:
- description: The ID of the cart that the payment session was potentially created for.
- nullable: true
- type: string
- cart:
- description: The details of the cart that the payment session was potentially created for.
- x-expandable: cart
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the payment session was potentially created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the payment session was potentially created for.
- x-expandable: order
- nullable: true
- type: object
- amount:
- description: The amount that the Payment has been authorized for.
- type: integer
- example: 100
- currency_code:
- description: The 3 character ISO currency code of the payment.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency of the payment.
- x-expandable: currency
- nullable: true
- $ref: '#/components/schemas/Currency'
- amount_refunded:
- description: The amount of the original Payment amount that has been refunded back to the Customer.
- type: integer
- default: 0
- example: 0
- provider_id:
- description: The id of the Payment Provider that is responsible for the Payment
- type: string
- example: manual
- data:
- description: The data required for the Payment Provider to identify, modify and process the Payment. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.
- type: object
- example: {}
- captured_at:
- description: The date with timezone at which the Payment was captured.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date with timezone at which the Payment was canceled.
- nullable: true
- type: string
- format: date-time
- idempotency_key:
- description: Randomly generated key used to continue the completion of a payment in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- PaymentCollection:
- title: Payment Collection
- description: A payment collection allows grouping and managing a list of payments at one. This can be helpful when making additional payment for order edits or integrating installment payments.
- type: object
- required:
- - amount
- - authorized_amount
- - created_at
- - created_by
- - currency_code
- - deleted_at
- - description
- - id
- - metadata
- - region_id
- - status
- - type
- - updated_at
- properties:
- id:
- description: The payment collection's ID
- type: string
- example: paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
- type:
- description: The type of the payment collection
- type: string
- enum:
- - order_edit
- status:
- description: The type of the payment collection
- type: string
- enum:
- - not_paid
- - awaiting
- - authorized
- - partially_authorized
- - canceled
- description:
- description: Description of the payment collection
- nullable: true
- type: string
- amount:
- description: Amount of the payment collection.
- type: integer
- authorized_amount:
- description: Authorized amount of the payment collection.
- nullable: true
- type: integer
- region_id:
- description: The ID of the region this payment collection is associated with.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this payment collection is associated with.
- x-expandable: region
- nullable: true
- $ref: '#/components/schemas/Region'
- currency_code:
- description: The three character ISO code for the currency this payment collection is associated with.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency this payment collection is associated with.
- x-expandable: currency
- nullable: true
- $ref: '#/components/schemas/Currency'
- payment_sessions:
- description: The details of the payment sessions created as part of the payment collection.
- type: array
- x-expandable: payment_sessions
- items:
- $ref: '#/components/schemas/PaymentSession'
- payments:
- description: The details of the payments created as part of the payment collection.
- type: array
- x-expandable: payments
- items:
- $ref: '#/components/schemas/Payment'
- created_by:
- description: The ID of the user that created the payment collection.
- type: string
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- PaymentProvider:
- title: Payment Provider
- description: A payment provider represents a payment service installed in the Medusa backend, either through a plugin or backend customizations. It holds the payment service's installation status.
- type: object
- required:
- - id
- - is_installed
- properties:
- id:
- description: The ID of the payment provider as given by the payment service.
- type: string
- example: manual
- is_installed:
- description: Whether the payment service is installed in the current version. If a payment service is no longer installed, the `is_installed` attribute is set to `false`.
- type: boolean
- default: true
- PaymentSession:
- title: Payment Session
- description: A Payment Session is created when a Customer initilizes the checkout flow, and can be used to hold the state of a payment flow. Each Payment Session is controlled by a Payment Provider, which is responsible for the communication with external payment services. Authorized Payment Sessions will eventually get promoted to Payments to indicate that they are authorized for payment processing such as capture or refund. Payment sessions can also be used as part of payment collections.
- type: object
- required:
- - amount
- - cart_id
- - created_at
- - data
- - id
- - is_initiated
- - is_selected
- - idempotency_key
- - payment_authorized_at
- - provider_id
- - status
- - updated_at
- properties:
- id:
- description: The payment session's ID
- type: string
- example: ps_01G901XNSRM2YS3ASN9H5KG3FZ
- cart_id:
- description: The ID of the cart that the payment session was created for.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the payment session was created for.
- x-expandable: cart
- nullable: true
- $ref: '#/components/schemas/Cart'
- provider_id:
- description: The ID of the Payment Provider that is responsible for the Payment Session
- type: string
- example: manual
- is_selected:
- description: A flag to indicate if the Payment Session has been selected as the method that will be used to complete the purchase.
- nullable: true
- type: boolean
- example: true
- is_initiated:
- description: A flag to indicate if a communication with the third party provider has been initiated.
- type: boolean
- default: false
- example: true
- status:
- description: Indicates the status of the Payment Session. Will default to `pending`, and will eventually become `authorized`. Payment Sessions may have the status of `requires_more` to indicate that further actions are to be completed by the Customer.
- type: string
- enum:
- - authorized
- - pending
- - requires_more
- - error
- - canceled
- example: pending
- data:
- description: The data required for the Payment Provider to identify, modify and process the Payment Session. Typically this will be an object that holds an id to the external payment session, but can be an empty object if the Payment Provider doesn't hold any state.
- type: object
- example: {}
- idempotency_key:
- description: Randomly generated key used to continue the completion of a cart in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- amount:
- description: The amount that the Payment Session has been authorized for.
- nullable: true
- type: integer
- example: 100
- payment_authorized_at:
- description: The date with timezone at which the Payment Session was authorized.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- PriceList:
- title: Price List
- description: A Price List represents a set of prices that override the default price for one or more product variants.
- type: object
- required:
- - created_at
- - deleted_at
- - description
- - ends_at
- - id
- - name
- - starts_at
- - status
- - type
- - updated_at
- properties:
- id:
- description: The price list's ID
- type: string
- example: pl_01G8X3CKJXCG5VXVZ87H9KC09W
- name:
- description: The price list's name
- type: string
- example: VIP Prices
- description:
- description: The price list's description
- type: string
- example: Prices for VIP customers
- type:
- description: The type of Price List. This can be one of either `sale` or `override`.
- type: string
- enum:
- - sale
- - override
- default: sale
- status:
- description: The status of the Price List
- type: string
- enum:
- - active
- - draft
- default: draft
- starts_at:
- description: The date with timezone that the Price List starts being valid.
- nullable: true
- type: string
- format: date-time
- ends_at:
- description: The date with timezone that the Price List stops being valid.
- nullable: true
- type: string
- format: date-time
- customer_groups:
- description: The details of the customer groups that the Price List can apply to.
- type: array
- x-expandable: customer_groups
- items:
- $ref: '#/components/schemas/CustomerGroup'
- prices:
- description: The prices that belong to the price list, represented as a Money Amount.
- type: array
- x-expandable: prices
- items:
- $ref: '#/components/schemas/MoneyAmount'
- includes_tax:
- description: Whether the price list prices include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- PricedProduct:
- title: Priced Product
- type: object
- allOf:
- - $ref: '#/components/schemas/Product'
- - type: object
- properties:
- variants:
- description: The product variants and their prices.
- type: array
- items:
- $ref: '#/components/schemas/PricedVariant'
- PricedShippingOption:
- title: Priced Shipping Option
- type: object
- allOf:
- - $ref: '#/components/schemas/ShippingOption'
- - type: object
- properties:
- price_incl_tax:
- type: number
- description: Price including taxes
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
- tax_amount:
- type: number
- description: The taxes applied.
- PricedVariant:
- title: Priced Product Variant
- type: object
- allOf:
- - $ref: '#/components/schemas/ProductVariant'
- - type: object
- properties:
- original_price:
- type: number
- description: The original price of the variant without any discounted prices applied.
- calculated_price:
- type: number
- description: The calculated price of the variant. Can be a discounted price.
- original_price_incl_tax:
- type: number
- description: The original price of the variant including taxes.
- calculated_price_incl_tax:
- type: number
- description: The calculated price of the variant including taxes.
- original_tax:
- type: number
- description: The taxes applied on the original price.
- calculated_tax:
- type: number
- description: The taxes applied on the calculated price.
- tax_rates:
- type: array
- description: An array of applied tax rates
- items:
- type: object
- properties:
- rate:
- type: number
- description: The tax rate value
- name:
- type: string
- description: The name of the tax rate
- code:
- type: string
- description: The code of the tax rate
- Product:
- title: Product
- description: A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.
- type: object
- required:
- - collection_id
- - created_at
- - deleted_at
- - description
- - discountable
- - external_id
- - handle
- - height
- - hs_code
- - id
- - is_giftcard
- - length
- - material
- - metadata
- - mid_code
- - origin_country
- - profile_id
- - status
- - subtitle
- - type_id
- - thumbnail
- - title
- - updated_at
- - weight
- - width
- properties:
- id:
- description: The product's ID
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- title:
- description: A title that can be displayed for easy identification of the Product.
- type: string
- example: Medusa Coffee Mug
- subtitle:
- description: An optional subtitle that can be used to further specify the Product.
- nullable: true
- type: string
- description:
- description: A short description of the Product.
- nullable: true
- type: string
- example: Every programmer's best friend.
- handle:
- description: A unique identifier for the Product (e.g. for slug structure).
- nullable: true
- type: string
- example: coffee-mug
- is_giftcard:
- description: Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.
- type: boolean
- default: false
- status:
- description: The status of the product
- type: string
- enum:
- - draft
- - proposed
- - published
- - rejected
- default: draft
- images:
- description: The details of the product's images.
- type: array
- x-expandable: images
- items:
- $ref: '#/components/schemas/Image'
- thumbnail:
- description: A URL to an image file that can be used to identify the Product.
- nullable: true
- type: string
- format: uri
- options:
- description: The details of the Product Options that are defined for the Product. The product's variants will have a unique combination of values of the product's options.
- type: array
- x-expandable: options
- items:
- $ref: '#/components/schemas/ProductOption'
- variants:
- description: The details of the Product Variants that belong to the Product. Each will have a unique combination of values of the product's options.
- type: array
- x-expandable: variants
- items:
- $ref: '#/components/schemas/ProductVariant'
- categories:
- description: The details of the product categories that this product belongs to.
- type: array
- x-expandable: categories
- x-featureFlag: product_categories
- items:
- $ref: '#/components/schemas/ProductCategory'
- profile_id:
- description: The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- profile:
- description: The details of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.
- x-expandable: profile
- nullable: true
- $ref: '#/components/schemas/ShippingProfile'
- profiles:
- description: Available if the relation `profiles` is expanded.
- nullable: true
- type: array
- items:
- $ref: '#/components/schemas/ShippingProfile'
- weight:
- description: The weight of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- length:
- description: The length of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- height:
- description: The height of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- width:
- description: The width of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- hs_code:
- description: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- origin_country:
- description: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- mid_code:
- description: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- material:
- description: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- collection_id:
- description: The ID of the product collection that the product belongs to.
- nullable: true
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- collection:
- description: The details of the product collection that the product belongs to.
- x-expandable: collection
- nullable: true
- $ref: '#/components/schemas/ProductCollection'
- type_id:
- description: The ID of the product type that the product belongs to.
- nullable: true
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- type:
- description: The details of the product type that the product belongs to.
- x-expandable: type
- nullable: true
- $ref: '#/components/schemas/ProductType'
- tags:
- description: The details of the product tags used in this product.
- type: array
- x-expandable: type
- items:
- $ref: '#/components/schemas/ProductTag'
- discountable:
- description: Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to `false`.
- type: boolean
- default: true
- external_id:
- description: The external ID of the product
- nullable: true
- type: string
- example: null
- sales_channels:
- description: The details of the sales channels this product is available in.
- type: array
- x-expandable: sales_channels
- items:
- $ref: '#/components/schemas/SalesChannel'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductCategory:
- title: Product Category
- description: A product category can be used to categorize products into a hierarchy of categories.
- x-resourceId: ProductCategory
- x-featureFlag: product_categories
- type: object
- required:
- - category_children
- - created_at
- - handle
- - id
- - is_active
- - is_internal
- - metadata
- - mpath
- - name
- - parent_category_id
- - updated_at
- properties:
- id:
- description: The product category's ID
- type: string
- example: pcat_01G2SG30J8C85S4A5CHM2S1NS2
- name:
- description: The product category's name
- type: string
- example: Regular Fit
- description:
- description: The product category's description.
- type: string
- default: ''
- handle:
- description: A unique string that identifies the Product Category - can for example be used in slug structures.
- type: string
- example: regular-fit
- mpath:
- description: A string for Materialized Paths - used for finding ancestors and descendents
- nullable: true
- type: string
- example: pcat_id1.pcat_id2.pcat_id3
- is_internal:
- type: boolean
- description: A flag to make product category an internal category for admins
- default: false
- is_active:
- type: boolean
- description: A flag to make product category visible/hidden in the store front
- default: false
- rank:
- type: integer
- description: An integer that depicts the rank of category in a tree node
- default: 0
- category_children:
- description: The details of the category's children.
- type: array
- x-expandable: category_children
- items:
- type: object
- parent_category_id:
- description: The ID of the parent category.
- nullable: true
- type: string
- default: null
- parent_category:
- description: The details of the parent of this category.
- x-expandable: parent_category
- nullable: true
- type: object
- products:
- description: The details of the products that belong to this category.
- type: array
- x-expandable: products
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductCollection:
- title: Product Collection
- description: A Product Collection allows grouping together products for promotional purposes. For example, an admin can create a Summer collection, add products to it, and showcase it on the storefront.
- type: object
- required:
- - created_at
- - deleted_at
- - handle
- - id
- - metadata
- - title
- - updated_at
- properties:
- id:
- description: The product collection's ID
- type: string
- example: pcol_01F0YESBFAZ0DV6V831JXWH0BG
- title:
- description: The title that the Product Collection is identified by.
- type: string
- example: Summer Collection
- handle:
- description: A unique string that identifies the Product Collection - can for example be used in slug structures.
- nullable: true
- type: string
- example: summer-collection
- products:
- description: The details of the products that belong to this product collection.
- type: array
- x-expandable: products
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductOption:
- title: Product Option
- description: A Product Option defines properties that may vary between different variants of a Product. Common Product Options are "Size" and "Color". Admins are free to create any product options.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - product_id
- - title
- - updated_at
- properties:
- id:
- description: The product option's ID
- type: string
- example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
- title:
- description: The title that the Product Option is defined by (e.g. `Size`).
- type: string
- example: Size
- values:
- description: The details of the values of the product option.
- type: array
- x-expandable: values
- items:
- $ref: '#/components/schemas/ProductOptionValue'
- product_id:
- description: The ID of the product that this product option belongs to.
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product that this product option belongs to.
- x-expandable: product
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductOptionValue:
- title: Product Option Value
- description: An option value is one of the possible values of a Product Option. Product Variants specify a unique combination of product option values.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - option_id
- - updated_at
- - value
- - variant_id
- properties:
- id:
- description: The product option value's ID
- type: string
- example: optval_01F0YESHR7S6ECD03RF6W12DSJ
- value:
- description: The value that the Product Variant has defined for the specific Product Option (e.g. if the Product Option is "Size" this value could be `Small`, `Medium` or `Large`).
- type: string
- example: large
- option_id:
- description: The ID of the Product Option that the Product Option Value belongs to.
- type: string
- example: opt_01F0YESHQBZVKCEXJ24BS6PCX3
- option:
- description: The details of the product option that the Product Option Value belongs to.
- x-expandable: option
- nullable: true
- type: object
- variant_id:
- description: The ID of the product variant that uses this product option value.
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- variant:
- description: The details of the product variant that uses this product option value.
- x-expandable: variant
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductTag:
- title: Product Tag
- description: A Product Tag can be added to Products for easy filtering and grouping.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
- properties:
- id:
- description: The product tag's ID
- type: string
- example: ptag_01G8K2MTMG9168F2B70S1TAVK3
- value:
- description: The value that the Product Tag represents
- type: string
- example: Pants
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductTaxRate:
- title: Product Tax Rate
- description: This represents the association between a tax rate and a product to indicate that the product is taxed in a way different than the default.
- type: object
- required:
- - created_at
- - metadata
- - product_id
- - rate_id
- - updated_at
- properties:
- product_id:
- description: The ID of the Product
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product.
- x-expandable: product
- nullable: true
- $ref: '#/components/schemas/Product'
- rate_id:
- description: The ID of the Tax Rate
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: '#/components/schemas/TaxRate'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductType:
- title: Product Type
- description: A Product Type can be added to Products for filtering and reporting purposes.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - updated_at
- - value
- properties:
- id:
- description: The product type's ID
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- value:
- description: The value that the Product Type represents.
- type: string
- example: Clothing
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductTypeTaxRate:
- title: Product Type Tax Rate
- description: This represents the association between a tax rate and a product type to indicate that the product type is taxed in a different way than the default.
- type: object
- required:
- - created_at
- - metadata
- - product_type_id
- - rate_id
- - updated_at
- properties:
- product_type_id:
- description: The ID of the Product type
- type: string
- example: ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A
- product_type:
- description: The details of the product type.
- x-expandable: product_type
- nullable: true
- $ref: '#/components/schemas/ProductType'
- rate_id:
- description: The id of the Tax Rate
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: '#/components/schemas/TaxRate'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ProductVariant:
- title: Product Variant
- description: A Product Variant represents a Product with a specific set of Product Option configurations. The maximum number of Product Variants that a Product can have is given by the number of available Product Option combinations. A product must at least have one product variant.
- type: object
- required:
- - allow_backorder
- - barcode
- - created_at
- - deleted_at
- - ean
- - height
- - hs_code
- - id
- - inventory_quantity
- - length
- - manage_inventory
- - material
- - metadata
- - mid_code
- - origin_country
- - product_id
- - sku
- - title
- - upc
- - updated_at
- - weight
- - width
- properties:
- id:
- description: The product variant's ID
- type: string
- example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
- title:
- description: A title that can be displayed for easy identification of the Product Variant.
- type: string
- example: Small
- product_id:
- description: The ID of the product that the product variant belongs to.
- type: string
- example: prod_01G1G5V2MBA328390B5AXJ610F
- product:
- description: The details of the product that the product variant belongs to.
- x-expandable: product
- nullable: true
- type: object
- prices:
- description: The details of the prices of the Product Variant, each represented as a Money Amount. Each Money Amount represents a price in a given currency or a specific Region.
- type: array
- x-expandable: prices
- items:
- $ref: '#/components/schemas/MoneyAmount'
- sku:
- description: The unique stock keeping unit used to identify the Product Variant. This will usually be a unique identifer for the item that is to be shipped, and can be referenced across multiple systems.
- nullable: true
- type: string
- example: shirt-123
- barcode:
- description: A generic field for a GTIN number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- ean:
- description: An EAN barcode number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- upc:
- description: A UPC barcode number that can be used to identify the Product Variant.
- nullable: true
- type: string
- example: null
- variant_rank:
- description: The ranking of this variant
- nullable: true
- type: number
- default: 0
- inventory_quantity:
- description: The current quantity of the item that is stocked.
- type: integer
- example: 100
- allow_backorder:
- description: Whether the Product Variant should be purchasable when `inventory_quantity` is 0.
- type: boolean
- default: false
- manage_inventory:
- description: Whether Medusa should manage inventory for the Product Variant.
- type: boolean
- default: true
- hs_code:
- description: The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- origin_country:
- description: The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- mid_code:
- description: The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- material:
- description: The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.
- nullable: true
- type: string
- example: null
- weight:
- description: The weight of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- length:
- description: The length of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- height:
- description: The height of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- width:
- description: The width of the Product Variant. May be used in shipping rate calculations.
- nullable: true
- type: number
- example: null
- options:
- description: The details of the product options that this product variant defines values for.
- type: array
- x-expandable: options
- items:
- $ref: '#/components/schemas/ProductOptionValue'
- inventory_items:
- description: The details inventory items of the product variant.
- type: array
- x-expandable: inventory_items
- items:
- $ref: '#/components/schemas/ProductVariantInventoryItem'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- purchasable:
- description: |
- Only used with the inventory modules.
- A boolean value indicating whether the Product Variant is purchasable.
- A variant is purchasable if:
- - inventory is not managed
- - it has no inventory items
- - it is in stock
- - it is backorderable.
- type: boolean
- ProductVariantInventoryItem:
- title: Product Variant Inventory Item
- description: A Product Variant Inventory Item links variants with inventory items and denotes the required quantity of the variant.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - inventory_item_id
- - required_quantity
- - updated_at
- - variant_id
- properties:
- id:
- description: The product variant inventory item's ID
- type: string
- example: pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A
- inventory_item_id:
- description: The id of the inventory item
- type: string
- variant_id:
- description: The id of the variant.
- type: string
- variant:
- description: The details of the product variant.
- x-expandable: variant
- nullable: true
- type: object
- required_quantity:
- description: The quantity of an inventory item required for the variant.
- type: integer
- default: 1
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- PublishableApiKey:
- title: Publishable API key
- description: A Publishable API key defines scopes that resources are available in. Then, it can be used in request to infer the resources without having to directly pass them. For example, a publishable API key can be associated with one or more sales channels. Then, when the publishable API key is passed in the header of a request, it is inferred what sales channel is being used without having to pass the sales channel as a query or body parameter of the request. Publishable API keys can only be used with sales channels, at the moment.
- type: object
- required:
- - created_at
- - created_by
- - id
- - revoked_by
- - revoked_at
- - title
- - updated_at
- properties:
- id:
- description: The key's ID
- type: string
- example: pk_01G1G5V27GYX4QXNARRQCW1N8T
- created_by:
- description: The unique identifier of the user that created the key.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- revoked_by:
- description: The unique identifier of the user that revoked the key.
- nullable: true
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- revoked_at:
- description: The date with timezone at which the key was revoked.
- nullable: true
- type: string
- format: date-time
- title:
- description: The key's title.
- type: string
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- PublishableApiKeySalesChannel:
- title: Publishable API Key Sales Channel
- description: This represents the association between the Publishable API keys and Sales Channels
- type: object
- required:
- - publishable_key_id
- - sales_channel_id
- - created_at
- - updated_at
- - deleted_at
- properties:
- id:
- description: The relation's ID
- type: string
- example: pksc_01G8X9A7ESKAJXG2H0E6F1MW7A
- sales_channel_id:
- description: The sales channel's ID
- type: string
- example: sc_01G1G5V21KADXNGH29BJMAJ4B4
- publishable_key_id:
- description: The publishable API key's ID
- type: string
- example: pak_01G1G5V21KADXNGH29BJMAJ4B4
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- Refund:
- title: Refund
- description: A refund represents an amount of money transfered back to the customer for a given reason. Refunds may occur in relation to Returns, Swaps and Claims, but can also be initiated by an admin for an order.
- type: object
- required:
- - amount
- - created_at
- - id
- - idempotency_key
- - metadata
- - note
- - order_id
- - payment_id
- - reason
- - updated_at
- properties:
- id:
- description: The refund's ID
- type: string
- example: ref_01G1G5V27GYX4QXNARRQCW1N8T
- order_id:
- description: The ID of the order this refund was created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order this refund was created for.
- x-expandable: order
- nullable: true
- type: object
- payment_id:
- description: The payment's ID, if available.
- nullable: true
- type: string
- example: pay_01G8ZCC5W42ZNY842124G7P5R9
- payment:
- description: The details of the payment associated with the refund.
- x-expandable: payment
- nullable: true
- type: object
- amount:
- description: The amount that has be refunded to the Customer.
- type: integer
- example: 1000
- note:
- description: An optional note explaining why the amount was refunded.
- nullable: true
- type: string
- example: I didn't like it
- reason:
- description: The reason given for the Refund, will automatically be set when processed as part of a Swap, Claim or Return.
- type: string
- enum:
- - discount
- - return
- - swap
- - claim
- - other
- example: return
- idempotency_key:
- description: Randomly generated key used to continue the completion of the refund in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- Region:
- title: Region
- description: A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
- type: object
- required:
- - automatic_taxes
- - created_at
- - currency_code
- - deleted_at
- - gift_cards_taxable
- - id
- - metadata
- - name
- - tax_code
- - tax_provider_id
- - tax_rate
- - updated_at
- properties:
- id:
- description: The region's ID
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- name:
- description: The name of the region as displayed to the customer. If the Region only has one country it is recommended to write the country name.
- type: string
- example: EU
- currency_code:
- description: The three character currency code used in the region.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- currency:
- description: The details of the currency used in the region.
- x-expandable: currency
- nullable: true
- $ref: '#/components/schemas/Currency'
- tax_rate:
- description: The tax rate that should be charged on purchases in the Region.
- type: number
- example: 0
- tax_rates:
- description: The details of the tax rates used in the region, aside from the default rate.
- type: array
- x-expandable: tax_rates
- items:
- $ref: '#/components/schemas/TaxRate'
- tax_code:
- description: The tax code used on purchases in the Region. This may be used by other systems for accounting purposes.
- nullable: true
- type: string
- example: null
- gift_cards_taxable:
- description: Whether the gift cards are taxable or not in this region.
- type: boolean
- default: true
- automatic_taxes:
- description: Whether taxes should be automated in this region.
- type: boolean
- default: true
- countries:
- description: The details of the countries included in this region.
- type: array
- x-expandable: countries
- items:
- $ref: '#/components/schemas/Country'
- tax_provider_id:
- description: The ID of the tax provider used in this region
- nullable: true
- type: string
- example: null
- tax_provider:
- description: The details of the tax provider used in the region.
- x-expandable: tax_provider
- nullable: true
- $ref: '#/components/schemas/TaxProvider'
- payment_providers:
- description: The details of the payment providers that can be used to process payments in the region.
- type: array
- x-expandable: payment_providers
- items:
- $ref: '#/components/schemas/PaymentProvider'
- fulfillment_providers:
- description: The details of the fulfillment providers that can be used to fulfill items of orders and similar resources in the region.
- type: array
- x-expandable: fulfillment_providers
- items:
- $ref: '#/components/schemas/FulfillmentProvider'
- includes_tax:
- description: Whether the prices for the region include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ReservationItemDTO:
- title: Reservation item
- description: Represents a reservation of an inventory item at a stock location
- type: object
- required:
- - id
- - location_id
- - inventory_item_id
- - quantity
- properties:
- id:
- description: The id of the reservation item
- type: string
- location_id:
- description: The id of the location of the reservation
- type: string
- inventory_item_id:
- description: The id of the inventory item the reservation relates to
- type: string
- description:
- description: Description of the reservation item
- type: string
- created_by:
- description: UserId of user who created the reservation item
- type: string
- quantity:
- description: The id of the reservation item
- type: number
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- Return:
- title: Return
- description: A Return holds information about Line Items that a Customer wishes to send back, along with how the items will be returned. Returns can also be used as part of a Swap or a Claim.
- type: object
- required:
- - claim_order_id
- - created_at
- - id
- - idempotency_key
- - location_id
- - metadata
- - no_notification
- - order_id
- - received_at
- - refund_amount
- - shipping_data
- - status
- - swap_id
- - updated_at
- properties:
- id:
- description: The return's ID
- type: string
- example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
- status:
- description: Status of the Return.
- type: string
- enum:
- - requested
- - received
- - requires_action
- - canceled
- default: requested
- items:
- description: The details of the items that the customer is returning.
- type: array
- x-expandable: items
- items:
- $ref: '#/components/schemas/ReturnItem'
- swap_id:
- description: The ID of the swap that the return may belong to.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the return may belong to.
- x-expandable: swap
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the return may belong to.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the return may belong to.
- x-expandable: claim_order
- nullable: true
- type: object
- order_id:
- description: The ID of the order that the return was created for.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the return was created for.
- x-expandable: order
- nullable: true
- type: object
- shipping_method:
- description: The details of the Shipping Method that will be used to send the Return back. Can be null if the Customer will handle the return shipment themselves.
- x-expandable: shipping_method
- nullable: true
- $ref: '#/components/schemas/ShippingMethod'
- shipping_data:
- description: Data about the return shipment as provided by the Fulfilment Provider that handles the return shipment.
- nullable: true
- type: object
- example: {}
- location_id:
- description: The ID of the stock location the return will be added back.
- nullable: true
- type: string
- example: sloc_01G8TJSYT9M6AVS5N4EMNFS1EK
- refund_amount:
- description: The amount that should be refunded as a result of the return.
- type: integer
- example: 1000
- no_notification:
- description: When set to true, no notification will be sent related to this return.
- nullable: true
- type: boolean
- example: false
- idempotency_key:
- description: Randomly generated key used to continue the completion of the return in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- received_at:
- description: The date with timezone at which the return was received.
- nullable: true
- type: string
- format: date-time
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ReturnItem:
- title: Return Item
- description: A return item represents a line item in an order that is to be returned. It includes details related to the return and the reason behind it.
- type: object
- required:
- - is_requested
- - item_id
- - metadata
- - note
- - quantity
- - reason_id
- - received_quantity
- - requested_quantity
- - return_id
- properties:
- return_id:
- description: The ID of the Return that the Return Item belongs to.
- type: string
- example: ret_01F0YET7XPCMF8RZ0Y151NZV2V
- item_id:
- description: The ID of the Line Item that the Return Item references.
- type: string
- example: item_01G8ZC9GWT6B2GP5FSXRXNFNGN
- return_order:
- description: Details of the Return that the Return Item belongs to.
- x-expandable: return_order
- nullable: true
- type: object
- item:
- description: The details of the line item in the original order to be returned.
- x-expandable: item
- nullable: true
- $ref: '#/components/schemas/LineItem'
- quantity:
- description: The quantity of the Line Item to be returned.
- type: integer
- example: 1
- is_requested:
- description: Whether the Return Item was requested initially or received unexpectedly in the warehouse.
- type: boolean
- default: true
- requested_quantity:
- description: The quantity that was originally requested to be returned.
- nullable: true
- type: integer
- example: 1
- received_quantity:
- description: The quantity that was received in the warehouse.
- nullable: true
- type: integer
- example: 1
- reason_id:
- description: The ID of the reason for returning the item.
- nullable: true
- type: string
- example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
- reason:
- description: The details of the reason for returning the item.
- x-expandable: reason
- nullable: true
- $ref: '#/components/schemas/ReturnReason'
- note:
- description: An optional note with additional details about the Return.
- nullable: true
- type: string
- example: I didn't like it.
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ReturnReason:
- title: Return Reason
- description: A Return Reason is a value defined by an admin. It can be used on Return Items in order to indicate why a Line Item was returned.
- type: object
- required:
- - created_at
- - deleted_at
- - description
- - id
- - label
- - metadata
- - parent_return_reason_id
- - updated_at
- - value
- properties:
- id:
- description: The return reason's ID
- type: string
- example: rr_01G8X82GCCV2KSQHDBHSSAH5TQ
- value:
- description: The value to identify the reason by.
- type: string
- example: damaged
- label:
- description: A text that can be displayed to the Customer as a reason.
- type: string
- example: Damaged goods
- description:
- description: A description of the Reason.
- nullable: true
- type: string
- example: Items that are damaged
- parent_return_reason_id:
- description: The ID of the parent reason.
- nullable: true
- type: string
- example: null
- parent_return_reason:
- description: The details of the parent reason.
- x-expandable: parent_return_reason
- nullable: true
- type: object
- return_reason_children:
- description: The details of the child reasons.
- x-expandable: return_reason_children
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- SalesChannel:
- title: Sales Channel
- description: A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
- type: object
- required:
- - created_at
- - deleted_at
- - description
- - id
- - is_disabled
- - name
- - updated_at
- properties:
- id:
- description: The sales channel's ID
- type: string
- example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
- name:
- description: The name of the sales channel.
- type: string
- example: Market
- description:
- description: The description of the sales channel.
- nullable: true
- type: string
- example: Multi-vendor market
- is_disabled:
- description: Specify if the sales channel is enabled or disabled.
- type: boolean
- default: false
- locations:
- description: The details of the stock locations related to the sales channel.
- type: array
- x-expandable: locations
- items:
- $ref: '#/components/schemas/SalesChannelLocation'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- carts:
- description: The associated carts.
- type: array
- nullable: true
- x-expandable: carts
- x-featureFlag: medusa_v2
- items:
- type: object
- orders:
- description: The associated orders.
- type: array
- nullable: true
- x-expandable: orders
- x-featureFlag: medusa_v2
- items:
- type: object
- publishableKeys:
- description: The associated publishable API keys.
- type: array
- nullable: true
- x-expandable: publishableKeys
- items:
- type: object
- SalesChannelLocation:
- title: Sales Channel Stock Location
- description: This represents the association between a sales channel and a stock locations.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - location_id
- - sales_channel_id
- - updated_at
- properties:
- id:
- description: The Sales Channel Stock Location's ID
- type: string
- example: scloc_01G8X9A7ESKAJXG2H0E6F1MW7A
- sales_channel_id:
- description: The ID of the Sales Channel
- type: string
- example: sc_01G8X9A7ESKAJXG2H0E6F1MW7A
- location_id:
- description: The ID of the Location Stock.
- type: string
- sales_channel:
- description: The details of the sales channel the location is associated with.
- x-expandable: sales_channel
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- ShippingMethod:
- title: Shipping Method
- description: A Shipping Method represents a way in which an Order or Return can be shipped. Shipping Methods are created from a Shipping Option, but may contain additional details that can be necessary for the Fulfillment Provider to handle the shipment. If the shipping method is created for a return, it may be associated with a claim or a swap that the return is part of.
- type: object
- required:
- - cart_id
- - claim_order_id
- - data
- - id
- - order_id
- - price
- - return_id
- - shipping_option_id
- - swap_id
- properties:
- id:
- description: The shipping method's ID
- type: string
- example: sm_01F0YET7DR2E7CYVSDHM593QG2
- shipping_option_id:
- description: The ID of the Shipping Option that the Shipping Method is built from.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- order_id:
- description: The ID of the order that the shipping method is used in.
- nullable: true
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the shipping method is used in.
- x-expandable: order
- nullable: true
- type: object
- claim_order_id:
- description: The ID of the claim that the shipping method is used in.
- nullable: true
- type: string
- example: null
- claim_order:
- description: The details of the claim that the shipping method is used in.
- x-expandable: claim_order
- nullable: true
- type: object
- cart_id:
- description: The ID of the cart that the shipping method is used in.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the shipping method is used in.
- x-expandable: cart
- nullable: true
- type: object
- swap_id:
- description: The ID of the swap that the shipping method is used in.
- nullable: true
- type: string
- example: null
- swap:
- description: The details of the swap that the shipping method is used in.
- x-expandable: swap
- nullable: true
- type: object
- return_id:
- description: The ID of the return that the shipping method is used in.
- nullable: true
- type: string
- example: null
- return_order:
- description: The details of the return that the shipping method is used in.
- x-expandable: return_order
- nullable: true
- type: object
- shipping_option:
- description: The details of the shipping option the method was created from.
- x-expandable: shipping_option
- nullable: true
- $ref: '#/components/schemas/ShippingOption'
- tax_lines:
- description: The details of the tax lines applied on the shipping method.
- type: array
- x-expandable: tax_lines
- items:
- $ref: '#/components/schemas/ShippingMethodTaxLine'
- price:
- description: The amount to charge for the Shipping Method. The currency of the price is defined by the Region that the Order that the Shipping Method belongs to is a part of.
- type: integer
- example: 200
- data:
- description: Additional data that the Fulfillment Provider needs to fulfill the shipment. This is used in combination with the Shipping Options data, and may contain information such as a drop point id.
- type: object
- example: {}
- includes_tax:
- description: Whether the shipping method price include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- subtotal:
- description: The subtotal of the shipping
- type: integer
- example: 8000
- total:
- description: The total amount of the shipping
- type: integer
- example: 8200
- tax_total:
- description: The total of tax
- type: integer
- example: 0
- ShippingMethodTaxLine:
- title: Shipping Method Tax Line
- description: A Shipping Method Tax Line represents the taxes applied on a shipping method in a cart.
- type: object
- required:
- - code
- - created_at
- - id
- - shipping_method_id
- - metadata
- - name
- - rate
- - updated_at
- properties:
- id:
- description: The line item tax line's ID
- type: string
- example: smtl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- shipping_method_id:
- description: The ID of the line item
- type: string
- example: sm_01F0YET7DR2E7CYVSDHM593QG2
- shipping_method:
- description: The details of the associated shipping method.
- x-expandable: shipping_method
- nullable: true
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ShippingOption:
- title: Shipping Option
- description: A Shipping Option represents a way in which an Order or Return can be shipped. Shipping Options have an associated Fulfillment Provider that will be used when the fulfillment of an Order is initiated. Shipping Options themselves cannot be added to Carts, but serve as a template for Shipping Methods. This distinction makes it possible to customize individual Shipping Methods with additional information.
- type: object
- required:
- - admin_only
- - amount
- - created_at
- - data
- - deleted_at
- - id
- - is_return
- - metadata
- - name
- - price_type
- - profile_id
- - provider_id
- - region_id
- - updated_at
- properties:
- id:
- description: The shipping option's ID
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- name:
- description: The name given to the Shipping Option - this may be displayed to the Customer.
- type: string
- example: PostFake Standard
- region_id:
- description: The ID of the region this shipping option can be used in.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region this shipping option can be used in.
- x-expandable: region
- nullable: true
- type: object
- profile_id:
- description: The ID of the Shipping Profile that the shipping option belongs to.
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- profile:
- description: The details of the shipping profile that the shipping option belongs to.
- x-expandable: profile
- nullable: true
- $ref: '#/components/schemas/ShippingProfile'
- provider_id:
- description: The ID of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.
- type: string
- example: manual
- provider:
- description: The details of the fulfillment provider that will be used to later to process the shipping method created from this shipping option and its fulfillments.
- x-expandable: provider
- nullable: true
- $ref: '#/components/schemas/FulfillmentProvider'
- price_type:
- description: The type of pricing calculation that is used when creatin Shipping Methods from the Shipping Option. Can be `flat_rate` for fixed prices or `calculated` if the Fulfillment Provider can provide price calulations.
- type: string
- enum:
- - flat_rate
- - calculated
- example: flat_rate
- amount:
- description: The amount to charge for shipping when the Shipping Option price type is `flat_rate`.
- nullable: true
- type: integer
- example: 200
- is_return:
- description: Flag to indicate if the Shipping Option can be used for Return shipments.
- type: boolean
- default: false
- admin_only:
- description: Flag to indicate if the Shipping Option usage is restricted to admin users.
- type: boolean
- default: false
- requirements:
- description: The details of the requirements that must be satisfied for the Shipping Option to be available for usage in a Cart.
- type: array
- x-expandable: requirements
- items:
- $ref: '#/components/schemas/ShippingOptionRequirement'
- data:
- description: The data needed for the Fulfillment Provider to identify the Shipping Option.
- type: object
- example: {}
- includes_tax:
- description: Whether the shipping option price include tax
- type: boolean
- x-featureFlag: tax_inclusive_pricing
- default: false
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ShippingOptionRequirement:
- title: Shipping Option Requirement
- description: A shipping option requirement defines conditions that a Cart must satisfy for the Shipping Option to be available for usage in the Cart.
- type: object
- required:
- - amount
- - deleted_at
- - id
- - shipping_option_id
- - type
- properties:
- id:
- description: The shipping option requirement's ID
- type: string
- example: sor_01G1G5V29AB4CTNDRFSRWSRKWD
- shipping_option_id:
- description: The ID of the shipping option that the requirements belong to.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the shipping option that the requirements belong to.
- x-expandable: shipping_option
- nullable: true
- type: object
- type:
- description: The type of the requirement, this defines how the value will be compared to the Cart's total. `min_subtotal` requirements define the minimum subtotal that is needed for the Shipping Option to be available, while the `max_subtotal` defines the maximum subtotal that the Cart can have for the Shipping Option to be available.
- type: string
- enum:
- - min_subtotal
- - max_subtotal
- example: min_subtotal
- amount:
- description: The amount to compare the Cart subtotal to.
- type: integer
- example: 100
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- ShippingProfile:
- title: Shipping Profile
- description: A Shipping Profile has a set of defined Shipping Options that can be used to fulfill a given set of Products. For example, gift cards are shipped differently than physical products, so a shipping profile with the type `gift_card` groups together the shipping options that can only be used for gift cards.
- type: object
- required:
- - created_at
- - deleted_at
- - id
- - metadata
- - name
- - type
- - updated_at
- properties:
- id:
- description: The shipping profile's ID
- type: string
- example: sp_01G1G5V239ENSZ5MV4JAR737BM
- name:
- description: The name given to the Shipping profile - this may be displayed to the Customer.
- type: string
- example: Default Shipping Profile
- type:
- description: The type of the Shipping Profile, may be `default`, `gift_card` or `custom`.
- type: string
- enum:
- - default
- - gift_card
- - custom
- example: default
- products:
- description: The details of the products that the Shipping Profile defines Shipping Options for. Available if the relation `products` is expanded.
- type: array
- x-expandable: products
- items:
- type: object
- shipping_options:
- description: The details of the shipping options that can be used to create shipping methods for the Products in the Shipping Profile.
- type: array
- x-expandable: shipping_options
- items:
- type: object
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- ShippingTaxRate:
- title: Shipping Tax Rate
- description: This represents the tax rates applied on a shipping option.
- type: object
- required:
- - created_at
- - metadata
- - rate_id
- - shipping_option_id
- - updated_at
- properties:
- shipping_option_id:
- description: The ID of the shipping option.
- type: string
- example: so_01G1G5V27GYX4QXNARRQCW1N8T
- shipping_option:
- description: The details of the shipping option.
- x-expandable: shipping_option
- nullable: true
- $ref: '#/components/schemas/ShippingOption'
- rate_id:
- description: The ID of the associated tax rate.
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- tax_rate:
- description: The details of the associated tax rate.
- x-expandable: tax_rate
- nullable: true
- $ref: '#/components/schemas/TaxRate'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- StagedJob:
- title: Staged Job
- description: A staged job resource
- type: object
- required:
- - data
- - event_name
- - id
- - options
- properties:
- id:
- description: The staged job's ID
- type: string
- example: job_01F0YET7BZTARY9MKN1SJ7AAXF
- event_name:
- description: The name of the event
- type: string
- example: order.placed
- data:
- description: Data necessary for the job
- type: object
- example: {}
- option:
- description: The staged job's option
- type: object
- example: {}
- StockLocationAddressDTO:
- title: Stock Location Address
- description: Represents a Stock Location Address
+ StockLocationAddress:
type: object
+ description: The stock location's address.
+ x-schemaName: StockLocationAddress
required:
- address_1
- country_code
- - created_at
- - updated_at
properties:
- id:
- type: string
- description: The stock location address' ID
- example: laddr_51G4ZW853Y6TFXWPG5ENJ81X42
address_1:
type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
+ title: address_1
+ description: The address's address 1.
address_2:
type: string
- description: Stock location address' complement
- example: apartment 4432
+ title: address_2
+ description: The address's address 2.
company:
type: string
- description: Stock location company' name
- example: Medusa
+ title: company
+ description: The address's company.
city:
type: string
- description: Stock location address' city
- example: Mexico city
+ title: city
+ description: The address's city.
country_code:
type: string
- description: Stock location address' country
- example: MX
+ title: country_code
+ description: The address's country code.
phone:
type: string
- description: Stock location address' phone number
- example: +1 555 61646
+ title: phone
+ description: The address's phone.
postal_code:
type: string
- description: Stock location address' postal code
- example: HD3-1G8
+ title: postal_code
+ description: The address's postal code.
province:
type: string
- description: Stock location address' province
- example: Sinaloa
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- StockLocationAddressInput:
- title: Stock Location Address Input
- description: Represents a Stock Location Address Input
+ title: province
+ description: The address's province.
+ StorePostCartsCartTaxesReq:
type: object
- required:
- - address_1
- - country_code
- properties:
- address_1:
- type: string
- description: Stock location address
- example: 35, Jhon Doe Ave
- address_2:
- type: string
- description: Stock location address' complement
- example: apartment 4432
- city:
- type: string
- description: Stock location address' city
- example: Mexico city
- country_code:
- type: string
- description: Stock location address' country
- example: MX
- phone:
- type: string
- description: Stock location address' phone number
- example: +1 555 61646
- postal_code:
- type: string
- description: Stock location address' postal code
- example: HD3-1G8
- province:
- type: string
- description: Stock location address' province
- example: Sinaloa
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- StockLocationDTO:
- title: Stock Location
- description: Represents a Stock Location
+ description: SUMMARY
+ x-schemaName: StorePostCartsCartTaxesReq
+ properties: {}
+ StorePostPaymentCollectionsPaymentSessionReq:
type: object
- required:
- - id
- - name
- - address_id
- - created_at
- - updated_at
- properties:
- id:
- type: string
- description: The stock location's ID
- example: sloc_51G4ZW853Y6TFXWPG5ENJ81X42
- address_id:
- type: string
- description: Stock location address' ID
- example: laddr_05B2ZE853Y6FTXWPW85NJ81A44
- name:
- type: string
- description: The name of the stock location
- example: Main Warehouse
- address:
- description: The Address of the Stock Location
- allOf:
- - $ref: '#/components/schemas/StockLocationAddressDTO'
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- created_at:
- type: string
- description: The date with timezone at which the resource was created.
- format: date-time
- updated_at:
- type: string
- description: The date with timezone at which the resource was updated.
- format: date-time
- deleted_at:
- type: string
- description: The date with timezone at which the resource was deleted.
- format: date-time
- StockLocationExpandedDTO:
- allOf:
- - $ref: '#/components/schemas/StockLocationDTO'
- - type: object
- properties:
- sales_channels:
- description: The associated sales channels.
- $ref: '#/components/schemas/SalesChannel'
- Store:
- title: Store
- description: A store holds the main settings of the commerce shop. By default, only one store is created and used within the Medusa backend. It holds settings related to the name of the store, available currencies, and more.
- type: object
- required:
- - created_at
- - default_currency_code
- - default_location_id
- - id
- - invite_link_template
- - metadata
- - name
- - payment_link_template
- - swap_link_template
- - updated_at
- properties:
- id:
- description: The store's ID
- type: string
- example: store_01G1G5V21KADXNGH29BJMAJ4B4
- name:
- description: The name of the Store - this may be displayed to the Customer.
- type: string
- example: Medusa Store
- default: Medusa Store
- default_currency_code:
- description: The three character currency code that is the default of the store.
- type: string
- example: usd
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- default_currency:
- description: The details of the store's default currency.
- x-expandable: default_currency
- default: usd
- nullable: true
- $ref: '#/components/schemas/Currency'
- currencies:
- description: The details of the enabled currencies in the store.
- type: array
- x-expandable: currencies
- items:
- $ref: '#/components/schemas/Currency'
- swap_link_template:
- description: A template to generate Swap links from. Use {{cart_id}} to include the Swap's `cart_id` in the link.
- nullable: true
- type: string
- example: null
- payment_link_template:
- description: A template to generate Payment links from. Use {{cart_id}} to include the payment's `cart_id` in the link.
- nullable: true
- type: string
- example: null
- invite_link_template:
- description: A template to generate Invite links from
- nullable: true
- type: string
- example: null
- default_location_id:
- description: The location ID the store is associated with.
- nullable: true
- type: string
- example: null
- default_sales_channel_id:
- description: The ID of the store's default sales channel.
- nullable: true
- type: string
- example: null
- default_sales_channel:
- description: The details of the store's default sales channel.
- x-expandable: default_sales_channel
- nullable: true
- $ref: '#/components/schemas/SalesChannel'
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- StoreAuthRes:
- type: object
- description: The customer's details.
- x-expanded-relations:
- field: customer
- relations:
- - orders
- - orders.items
- - shipping_addresses
- required:
- - customer
- properties:
- customer:
- description: Customer's details.
- $ref: '#/components/schemas/Customer'
- StoreBearerAuthRes:
- type: object
- description: The access token details.
- properties:
- access_token:
- description: Access token that can be used to send authenticated requests.
- type: string
- StoreCartShippingOptionsListRes:
- type: object
- x-expanded-relations:
- field: shipping_options
- implicit:
- - profile
- - requirements
- required:
- - shipping_options
- properties:
- shipping_options:
- type: array
- description: An array of shipping options details.
- items:
- $ref: '#/components/schemas/PricedShippingOption'
- StoreCartsRes:
- type: object
- description: The cart's details.
- x-expanded-relations:
- field: cart
- relations:
- - billing_address
- - discounts
- - discounts.rule
- - gift_cards
- - items
- - items.adjustments
- - items.variant
- - payment
- - payment_sessions
- - region
- - region.countries
- - region.payment_providers
- - shipping_address
- - shipping_methods
- eager:
- - region.fulfillment_providers
- - region.payment_providers
- - shipping_methods.shipping_option
- implicit:
- - items
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - items.tax_lines
- - items.adjustments
- - gift_cards
- - discounts
- - discounts.rule
- - shipping_methods
- - shipping_methods.tax_lines
- - shipping_address
- - region
- - region.tax_rates
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - item_tax_total
- - refundable_amount
- - refunded_total
- - shipping_tax_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- required:
- - cart
- properties:
- cart:
- description: Cart details.
- $ref: '#/components/schemas/Cart'
- StoreCollectionsListRes:
- type: object
- description: The list of product collections with pagination fields.
- required:
- - collections
- - count
- - offset
- - limit
- properties:
- collections:
- type: array
- description: An array of product collections details
- items:
- $ref: '#/components/schemas/ProductCollection'
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product collections skipped when retrieving the product collections.
- limit:
- type: integer
- description: The number of items per page
- StoreCollectionsRes:
- type: object
- description: The details of the product collection.
- required:
- - collection
- properties:
- collection:
- description: Product collection details.
- $ref: '#/components/schemas/ProductCollection'
- StoreCompleteCartRes:
- type: object
- description: If the cart is completed successfully, this will have the created order or the swap's details, based on the cart's type. Otherwise, it'll be the cart's details.
- required:
- - type
- - data
- properties:
- type:
- type: string
- description: The type of the data property. If the cart completion fails, type will be `cart` and the data object will be the cart's details. If the cart completion is successful and the cart is used for checkout, type will be `order` and the data object will be the order's details. If the cart completion is successful and the cart is used for swap creation, type will be `swap` and the data object will be the swap's details.
- enum:
- - order
- - cart
- - swap
- data:
- type: object
- description: The data of the result object. Its type depends on the type field.
- oneOf:
- - type: object
- allOf:
- - description: Cart was successfully authorized and order was placed successfully.
- - $ref: '#/components/schemas/Order'
- - type: object
- allOf:
- - description: Cart was successfully authorized but requires further actions.
- - $ref: '#/components/schemas/Cart'
- - type: object
- allOf:
- - description: Cart was used for a swap and it has been completed successfully.
- - $ref: '#/components/schemas/Swap'
- StoreCustomersListOrdersRes:
- type: object
- description: The list of the customer's orders with pagination fields.
- x-expanded-relations:
- field: orders
- relations:
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.tracking_links
- - items
- - items.variant
- - payments
- - region
- - shipping_address
- - shipping_methods
- eager:
- - region.fulfillment_providers
- - region.payment_providers
- - shipping_methods.shipping_option
- implicit:
- - claims
- - claims.additional_items
- - claims.additional_items.adjustments
- - claims.additional_items.refundable
- - claims.additional_items.tax_lines
- - customer
- - discounts
- - discounts.rule
- - gift_card_transactions
- - gift_card_transactions.gift_card
- - gift_cards
- - items
- - items.adjustments
- - items.refundable
- - items.tax_lines
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - refunds
- - region
- - shipping_address
- - shipping_methods
- - shipping_methods.tax_lines
- - swaps
- - swaps.additional_items
- - swaps.additional_items.adjustments
- - swaps.additional_items.refundable
- - swaps.additional_items.tax_lines
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - paid_total
- - refundable_amount
- - refunded_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - claims.additional_items.discount_total
- - claims.additional_items.gift_card_total
- - claims.additional_items.original_tax_total
- - claims.additional_items.original_total
- - claims.additional_items.refundable
- - claims.additional_items.subtotal
- - claims.additional_items.tax_total
- - claims.additional_items.total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- - swaps.additional_items.discount_total
- - swaps.additional_items.gift_card_total
- - swaps.additional_items.original_tax_total
- - swaps.additional_items.original_total
- - swaps.additional_items.refundable
- - swaps.additional_items.subtotal
- - swaps.additional_items.tax_total
- - swaps.additional_items.total
- required:
- - orders
- - count
- - offset
- - limit
- properties:
- orders:
- type: array
- description: An array of orders details.
- items:
- $ref: '#/components/schemas/Order'
- count:
- description: The total number of items available
- type: integer
- offset:
- description: The number of orders skipped when retrieving the orders.
- type: integer
- limit:
- description: The number of items per page
- type: integer
- StoreCustomersListPaymentMethodsRes:
- type: object
- description: The payment method's details.
- required:
- - payment_methods
- properties:
- payment_methods:
- type: array
- description: The details of the saved payment methods.
- items:
- type: object
- required:
- - provider_id
- - data
- properties:
- provider_id:
- description: The ID of the Payment Provider where the payment method is saved.
- type: string
- data:
- description: The data needed for the Payment Provider to use the saved payment method.
- type: object
- StoreCustomersRes:
- type: object
- description: The customer's details.
- x-expanded-relations:
- field: customer
- relations:
- - billing_address
- - shipping_addresses
- required:
- - customer
- properties:
- customer:
- description: Customer details.
- $ref: '#/components/schemas/Customer'
- StoreCustomersResetPasswordRes:
- type: object
- required:
- - customer
- properties:
- customer:
- description: Customer details.
- $ref: '#/components/schemas/Customer'
- StoreGetAuthEmailRes:
- type: object
- description: Details on whether the email exists.
- required:
- - exists
- properties:
- exists:
- description: Whether email exists or not.
- type: boolean
- StoreGetProductCategoriesCategoryRes:
- type: object
- description: The product category's details.
- x-expanded-relations:
- field: product_category
- relations:
- - category_children
- - parent_category
- required:
- - product_category
- properties:
- product_category:
- description: Product category details.
- $ref: '#/components/schemas/ProductCategory'
- StoreGetProductCategoriesRes:
- type: object
- description: The list of product categories with pagination fields.
- x-expanded-relations:
- field: product_categories
- relations:
- - category_children
- - parent_category
- required:
- - product_categories
- - count
- - offset
- - limit
- properties:
- product_categories:
- type: array
- description: An array of product categories details.
- items:
- $ref: '#/components/schemas/ProductCategory'
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product categories skipped when retrieving the product categories.
- limit:
- type: integer
- description: The number of items per page
- StoreGiftCardsRes:
- description: The gift card's details.
- type: object
- required:
- - gift_card
- properties:
- gift_card:
- description: Gift card details.
- $ref: '#/components/schemas/GiftCard'
- StoreOrderEditsRes:
- type: object
- description: The order edit's details.
- x-expanded-relations:
- field: order_edit
- relations:
- - changes
- - changes.line_item
- - changes.line_item.variant
- - changes.original_line_item
- - changes.original_line_item.variant
- - items
- - items.adjustments
- - items.tax_lines
- - items.variant
- - payment_collection
- implicit:
- - items
- - items.tax_lines
- - items.adjustments
- - items.variant
- totals:
- - difference_due
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- required:
- - order_edit
- properties:
- order_edit:
- description: Order edit details.
- $ref: '#/components/schemas/OrderEdit'
- StoreOrdersRes:
- type: object
- description: The order's details.
- required:
- - order
- x-expanded-relations:
- field: order
- relations:
- - customer
- - discounts
- - discounts.rule
- - fulfillments
- - fulfillments.tracking_links
- - items
- - items.variant
- - payments
- - region
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
- - region.fulfillment_providers
- - region.payment_providers
- - shipping_methods.shipping_option
- implicit:
- - claims
- - claims.additional_items
- - claims.additional_items.adjustments
- - claims.additional_items.refundable
- - claims.additional_items.tax_lines
- - discounts
- - discounts.rule
- - gift_card_transactions
- - gift_card_transactions.gift_card
- - gift_cards
- - items
- - items.adjustments
- - items.refundable
- - items.tax_lines
- - items.variant
- - items.variant.product
- - items.variant.product.profiles
- - refunds
- - region
- - shipping_methods
- - shipping_methods.tax_lines
- - swaps
- - swaps.additional_items
- - swaps.additional_items.adjustments
- - swaps.additional_items.refundable
- - swaps.additional_items.tax_lines
- totals:
- - discount_total
- - gift_card_tax_total
- - gift_card_total
- - paid_total
- - refundable_amount
- - refunded_total
- - shipping_total
- - subtotal
- - tax_total
- - total
- - claims.additional_items.discount_total
- - claims.additional_items.gift_card_total
- - claims.additional_items.original_tax_total
- - claims.additional_items.original_total
- - claims.additional_items.refundable
- - claims.additional_items.subtotal
- - claims.additional_items.tax_total
- - claims.additional_items.total
- - items.discount_total
- - items.gift_card_total
- - items.original_tax_total
- - items.original_total
- - items.refundable
- - items.subtotal
- - items.tax_total
- - items.total
- - swaps.additional_items.discount_total
- - swaps.additional_items.gift_card_total
- - swaps.additional_items.original_tax_total
- - swaps.additional_items.original_total
- - swaps.additional_items.refundable
- - swaps.additional_items.subtotal
- - swaps.additional_items.tax_total
- - swaps.additional_items.total
- properties:
- order:
- description: Order details.
- $ref: '#/components/schemas/Order'
- StorePaymentCollectionSessionsReq:
- type: object
- description: The details of the payment session to manage.
+ description: SUMMARY
+ x-schemaName: StorePostPaymentCollectionsPaymentSessionReq
required:
- provider_id
properties:
provider_id:
type: string
- description: The ID of the Payment Provider.
- StorePaymentCollectionsRes:
- type: object
- description: The payment collection's details.
- x-expanded-relations:
- field: payment_collection
- relations:
- - payment_sessions
- - region
- eager:
- - region.fulfillment_providers
- - region.payment_providers
- required:
- - payment_collection
- properties:
- payment_collection:
- description: Payment collection's details.
- $ref: '#/components/schemas/PaymentCollection'
- StorePaymentCollectionsSessionRes:
- type: object
- description: The details of the payment session.
- required:
- - payment_session
- properties:
- payment_session:
- description: Payment session's details.
- $ref: '#/components/schemas/PaymentSession'
- StorePostAuthReq:
- type: object
- required:
- - email
- - password
- properties:
- email:
- type: string
- description: The Customer's email.
- password:
- type: string
- description: The Customer's password.
- StorePostCartReq:
- type: object
- description: The details of the cart to be created.
- properties:
- region_id:
- type: string
- description: The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency. If this parameter is not provided, the first region in the store is used by default.
- sales_channel_id:
- type: string
- description: The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources. If you add a publishable API key in the header of this request, you don't specify a sales channel ID, and the publishable API key is associated with one sales channel, that sales channel will be attached to the cart. If no sales channel is passed and no publishable API key header is passed or the publishable API key isn't associated with any sales channel, the cart will not be associated with any sales channel.
- country_code:
- type: string
- description: The two character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address.
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- items:
- description: An array of product variants to generate line items from.
- type: array
- items:
- type: object
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- description: The ID of the Product Variant.
- type: string
- quantity:
- description: The quantity to add into the cart.
- type: integer
- context:
- description: An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`
- type: object
- example:
- ip: '::1'
- user_agent: Chrome
- StorePostCartsCartLineItemsItemReq:
- type: object
- description: The details to update of the line item.
- required:
- - quantity
- properties:
- quantity:
- type: number
- description: The quantity of the line item in the cart.
- metadata:
- type: object
- description: An optional key-value map with additional details about the Line Item. If omitted, the metadata will remain unchanged."
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- StorePostCartsCartLineItemsReq:
- type: object
- description: The details of the line item to create.
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- type: string
- description: The id of the Product Variant to generate the Line Item from.
- quantity:
- type: number
- description: The quantity of the Product Variant to add to the Line Item.
- metadata:
- type: object
- description: An optional key-value map with additional details about the Line Item.
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- StorePostCartsCartPaymentSessionReq:
- type: object
- description: The details of the payment session to set.
- required:
- - provider_id
- properties:
- provider_id:
- type: string
- description: The ID of the Payment Provider.
- StorePostCartsCartPaymentSessionUpdateReq:
- type: object
- required:
- - data
- properties:
+ title: provider_id
+ description: The payment collection's provider id.
+ context: {}
data:
type: object
- description: The data to update the payment session with.
- StorePostCartsCartReq:
- type: object
- description: The details to update of the cart.
- properties:
- region_id:
- type: string
- description: The ID of the Region to create the Cart in. Setting the cart's region can affect the pricing of the items in the cart as well as the used currency.
- country_code:
- type: string
- description: The 2 character ISO country code to create the Cart in. Setting this parameter will set the country code of the shipping address.
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
- description: See a list of codes.
- email:
- type: string
- description: An email to be used on the Cart.
- format: email
- sales_channel_id:
- type: string
- description: The ID of the Sales channel to create the Cart in. The cart's sales channel affects which products can be added to the cart. If a product does not exist in the cart's sales channel, it cannot be added to the cart. If you add a publishable API key in the header of this request and specify a sales channel ID, the specified sales channel must be within the scope of the publishable API key's resources.
- billing_address:
- description: The Address to be used for billing purposes.
- anyOf:
- - $ref: '#/components/schemas/AddressPayload'
- description: A full billing address object.
- - type: string
- description: The billing address ID
- shipping_address:
- description: The Address to be used for shipping purposes.
- anyOf:
- - $ref: '#/components/schemas/AddressPayload'
- description: A full shipping address object.
- - type: string
- description: The shipping address ID
- gift_cards:
- description: An array of Gift Card codes to add to the Cart.
- type: array
- items:
- type: object
- required:
- - code
- properties:
- code:
- description: The code of a gift card.
- type: string
- discounts:
- description: An array of Discount codes to add to the Cart.
- type: array
- items:
- type: object
- required:
- - code
- properties:
- code:
- description: The code of the discount.
- type: string
- customer_id:
- description: The ID of the Customer to associate the Cart with.
- type: string
- context:
- description: An object to provide context to the Cart. The `context` field is automatically populated with `ip` and `user_agent`
- type: object
- example:
- ip: '::1'
- user_agent: Chrome
- StorePostCartsCartShippingMethodReq:
- type: object
- description: The details of the shipping method to add to the cart.
- required:
- - option_id
- properties:
- option_id:
- type: string
- description: ID of the shipping option to create the method from.
- data:
- type: object
- description: Used to hold any data that the shipping method may need to process the fulfillment of the order. This depends on the fulfillment provider you're using.
- StorePostCustomersCustomerAcceptClaimReq:
- type: object
- description: The details necessary to grant order access.
- required:
- - token
- properties:
- token:
- description: The claim token generated by previous request to the Claim Order API Route.
- type: string
- StorePostCustomersCustomerAddressesAddressReq:
- anyOf:
- - $ref: '#/components/schemas/AddressPayload'
- StorePostCustomersCustomerAddressesReq:
- type: object
- required:
- - address
- properties:
- address:
- description: The Address to add to the Customer's saved addresses.
- $ref: '#/components/schemas/AddressCreatePayload'
- StorePostCustomersCustomerOrderClaimReq:
- type: object
- description: The details of the orders to claim.
- required:
- - order_ids
- properties:
- order_ids:
- description: The ID of the orders to claim
- type: array
- items:
- type: string
- StorePostCustomersCustomerPasswordTokenReq:
- type: object
- required:
- - email
- properties:
- email:
- description: The customer's email.
- type: string
- format: email
- StorePostCustomersCustomerReq:
- type: object
- description: The details to update of the customer.
- properties:
- first_name:
- description: The customer's first name.
- type: string
- last_name:
- description: The customer's last name.
- type: string
- billing_address:
- description: The address to be used for billing purposes.
- anyOf:
- - $ref: '#/components/schemas/AddressPayload'
- description: The full billing address object
- - type: string
- description: The ID of an existing billing address
- password:
- description: The customer's password.
- type: string
- phone:
- description: The customer's phone number.
- type: string
- email:
- description: The customer's email.
- type: string
- metadata:
- description: Additional custom data about the customer.
- type: object
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- StorePostCustomersReq:
- type: object
- description: The details of the customer to create.
- required:
- - first_name
- - last_name
- - email
- - password
- properties:
- first_name:
- description: The customer's first name.
- type: string
- last_name:
- description: The customer's last name.
- type: string
- email:
- description: The customer's email.
- type: string
- format: email
- password:
- description: The customer's password.
- type: string
- format: password
- phone:
- description: The customer's phone number.
- type: string
- StorePostCustomersResetPasswordReq:
- type: object
- required:
- - email
- - password
- - token
- properties:
- email:
- description: The customer's email.
- type: string
- format: email
- password:
- description: The customer's password.
- type: string
- format: password
- token:
- description: The reset password token
- type: string
- StorePostOrderEditsOrderEditDecline:
- type: object
- description: The details of the order edit's decline.
- properties:
- declined_reason:
- type: string
- description: The reason for declining the Order Edit.
- StorePostPaymentCollectionsBatchSessionsAuthorizeReq:
- type: object
- description: The details of the payment sessions to authorize.
- required:
- - session_ids
- properties:
- session_ids:
- description: List of Payment Session IDs to authorize.
- type: array
- items:
- type: string
- StorePostPaymentCollectionsBatchSessionsReq:
- type: object
- description: The details of the payment sessions to manage.
- required:
- - sessions
- properties:
- sessions:
- description: Payment sessions related to the Payment Collection. Existing sessions that are not added in this array will be deleted.
- type: array
- items:
- type: object
- required:
- - provider_id
- - amount
- properties:
- provider_id:
- type: string
- description: The ID of the Payment Provider.
- amount:
- type: integer
- description: The payment amount
- session_id:
- type: string
- description: The ID of the Payment Session to be updated. If no ID is provided, a new payment session is created.
- StorePostReturnsReq:
- type: object
- description: The details of the return to create.
- required:
- - order_id
- - items
- properties:
- order_id:
- type: string
- description: The ID of the Order to create the return for.
- items:
- description: The items to include in the return.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the line item to return.
- type: string
- quantity:
- description: The quantity to return.
- type: integer
- reason_id:
- description: The ID of the return reason. Return reasons can be retrieved from the List Return Reasons API Route.
- type: string
- note:
- description: A note to add to the item returned.
- type: string
- return_shipping:
- description: The return shipping method used to return the items. If provided, a fulfillment is automatically created for the return.
- type: object
- required:
- - option_id
- properties:
- option_id:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- StorePostSearchReq:
- type: object
- properties:
- q:
- type: string
- description: The search query.
- offset:
- type: number
- description: The number of products to skip when retrieving the products.
- limit:
- type: number
- description: Limit the number of products returned.
- filter:
- description: Pass filters based on the search service.
- StorePostSearchRes:
- description: The list of search results.
- allOf:
- - type: object
- required:
- - hits
- properties:
- hits:
- description: Array of search results. The format of the items depends on the search engine installed on the Medusa backend.
- type: array
- - type: object
- StorePostSwapsReq:
- type: object
- description: The details of the swap to create.
- required:
- - order_id
- - return_items
- - additional_items
- properties:
- order_id:
- type: string
- description: The ID of the Order to create the Swap for.
- return_items:
- description: The items to include in the Return.
- type: array
- items:
- type: object
- required:
- - item_id
- - quantity
- properties:
- item_id:
- description: The ID of the order's line item to return.
- type: string
- quantity:
- description: The quantity to return.
- type: integer
- reason_id:
- description: The ID of the reason of this return. Return reasons can be retrieved from the List Return Reasons API Route.
- type: string
- note:
- description: The note to add to the item being swapped.
- type: string
- return_shipping_option:
- type: string
- description: The ID of the Shipping Option to create the Shipping Method from.
- additional_items:
- description: The items to exchange the returned items with.
- type: array
- items:
- type: object
- required:
- - variant_id
- - quantity
- properties:
- variant_id:
- description: The ID of the Product Variant.
- type: string
- quantity:
- description: The quantity of the variant.
- type: integer
- StoreProductTagsListRes:
- type: object
- description: The list of product tags with pagination fields.
- required:
- - product_tags
- - count
- - offset
- - limit
- properties:
- product_tags:
- type: array
- description: An array of product tags details.
- items:
- $ref: '#/components/schemas/ProductTag'
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product tags skipped when retrieving the product tags.
- limit:
- type: integer
- description: The number of items per page
- StoreProductTypesListRes:
- type: object
- required:
- - product_types
- - count
- - offset
- - limit
- properties:
- product_types:
- type: array
- description: An array of product types details.
- items:
- $ref: '#/components/schemas/ProductType'
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of product types skipped when retrieving the product types.
- limit:
- type: integer
- description: The number of items per page
- StoreProductsListRes:
- type: object
- description: The list of products with pagination fields.
- x-expanded-relations:
- field: products
- relations:
- - collection
- - images
- - options
- - options.values
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
- totals:
- - variants.purchasable
- required:
- - products
- - count
- - offset
- - limit
- properties:
- products:
- type: array
- description: An array of products details.
- items:
- $ref: '#/components/schemas/PricedProduct'
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of products skipped when retrieving the products.
- limit:
- type: integer
- description: The number of items per page
- StoreProductsRes:
- type: object
- x-expanded-relations:
- field: product
- relations:
- - collection
- - images
- - options
- - options.values
- - tags
- - type
- - variants
- - variants.options
- - variants.prices
- totals:
- - variants.purchasable
- required:
- - product
- properties:
- product:
- description: Product details.
- $ref: '#/components/schemas/PricedProduct'
- StoreRegionsListRes:
- type: object
- description: The list of regions with pagination fields.
- x-expanded-relations:
- field: regions
- relations:
- - countries
- - payment_providers
- - fulfillment_providers
- eager:
- - payment_providers
- - fulfillment_providers
- required:
- - regions
- properties:
- regions:
- type: array
- description: An array of regions details.
- items:
- $ref: '#/components/schemas/Region'
- count:
- type: integer
- description: The total number of items available
- offset:
- type: integer
- description: The number of regions skipped when retrieving the regions.
- limit:
- type: integer
- description: The number of items per page
- StoreRegionsRes:
- type: object
- description: The region's details.
- x-expanded-relations:
- field: region
- relations:
- - countries
- - payment_providers
- - fulfillment_providers
- eager:
- - payment_providers
- - fulfillment_providers
- required:
- - region
- properties:
- region:
- description: Region details.
- $ref: '#/components/schemas/Region'
- StoreReturnReasonsListRes:
- type: object
- description: The list of return reasons.
- x-expanded-relations:
- field: return_reasons
- relations:
- - parent_return_reason
- - return_reason_children
- required:
- - return_reasons
- properties:
- return_reasons:
- type: array
- description: An array of return reasons details.
- items:
- $ref: '#/components/schemas/ReturnReason'
- StoreReturnReasonsRes:
- type: object
- description: The return reason's details.
- x-expanded-relations:
- field: return_reason
- relations:
- - parent_return_reason
- - return_reason_children
- required:
- - return_reason
- properties:
- return_reason:
- description: Return reason details.
- $ref: '#/components/schemas/ReturnReason'
- StoreReturnsRes:
- type: object
- description: The return's details.
- x-expanded-relations:
- field: return
- relations:
- - items
- - items.reason
- eager:
- - items
- required:
- - return
- properties:
- return:
- description: Return details.
- $ref: '#/components/schemas/Return'
- StoreShippingOptionsListRes:
- type: object
- description: The list of shipping options.
- x-expanded-relations:
- field: shipping_options
- relations:
- - requirements
- required:
- - shipping_options
- properties:
- shipping_options:
- type: array
- description: An array of shipping options details.
- items:
- $ref: '#/components/schemas/PricedShippingOption'
- StoreSwapsRes:
- type: object
- description: The swap's details.
- x-expanded-relations:
- field: swap
- relations:
- - additional_items
- - additional_items.variant
- - cart
- - fulfillments
- - order
- - payment
- - return_order
- - return_order.shipping_method
- - shipping_address
- - shipping_methods
- eager:
- - fulfillments.items
- required:
- - swap
- properties:
- swap:
- description: Swap details.
- $ref: '#/components/schemas/Swap'
- StoreVariantsListRes:
- type: object
- description: The list of product variants.
- x-expanded-relations:
- field: variants
- relations:
- - prices
- - options
- - product
- totals:
- - purchasable
- required:
- - variants
- properties:
- variants:
- type: array
- description: An array of product variant descriptions.
- items:
- $ref: '#/components/schemas/PricedVariant'
- StoreVariantsRes:
- type: object
- description: The product variant's details.
- x-expanded-relations:
- field: variant
- relations:
- - prices
- - options
- - product
- totals:
- - purchasable
- required:
- - variant
- properties:
- variant:
- description: Product variant description.
- $ref: '#/components/schemas/PricedVariant'
- Swap:
- title: Swap
- description: A swap can be created when a Customer wishes to exchange Products that they have purchased with different Products. It consists of a Return of previously purchased Products and a Fulfillment of new Products. It also includes information on any additional payment or refund required based on the difference between the exchanged products.
- type: object
- required:
- - allow_backorder
- - canceled_at
- - cart_id
- - confirmed_at
- - created_at
- - deleted_at
- - difference_due
- - fulfillment_status
- - id
- - idempotency_key
- - metadata
- - no_notification
- - order_id
- - payment_status
- - shipping_address_id
- - updated_at
- properties:
- id:
- description: The swap's ID
- type: string
- example: swap_01F0YET86Y9G92D3YDR9Y6V676
- fulfillment_status:
- description: The status of the Fulfillment of the Swap.
- type: string
- enum:
- - not_fulfilled
- - fulfilled
- - shipped
- - partially_shipped
- - canceled
- - requires_action
- example: not_fulfilled
- payment_status:
- description: The status of the Payment of the Swap. The payment may either refer to the refund of an amount or the authorization of a new amount.
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - confirmed
- - canceled
- - difference_refunded
- - partially_refunded
- - refunded
- - requires_action
- example: not_paid
- order_id:
- description: The ID of the order that the swap belongs to.
- type: string
- example: order_01G8TJSYT9M6AVS5N4EMNFS1EK
- order:
- description: The details of the order that the swap belongs to.
- x-expandable: order
- nullable: true
- type: object
- additional_items:
- description: The details of the new products to send to the customer, represented as line items.
- type: array
- x-expandable: additional_items
- items:
- $ref: '#/components/schemas/LineItem'
- return_order:
- description: The details of the return that belongs to the swap, which holds the details on the items being returned.
- x-expandable: return_order
- nullable: true
- type: object
- fulfillments:
- description: The details of the fulfillments that are used to send the new items to the customer.
- x-expandable: fulfillments
- type: array
- items:
- type: object
- payment:
- description: The details of the additional payment authorized by the customer when `difference_due` is positive.
- x-expandable: payment
- nullable: true
- type: object
- difference_due:
- description: The difference amount between the order’s original total and the new total imposed by the swap. If its value is negative, a refund must be issues to the customer. If it's positive, additional payment must be authorized by the customer. Otherwise, no payment processing is required.
- nullable: true
- type: integer
- example: 0
- shipping_address_id:
- description: The Address to send the new Line Items to - in most cases this will be the same as the shipping address on the Order.
- nullable: true
- type: string
- example: addr_01G8ZH853YPY9B94857DY91YGW
- shipping_address:
- description: The details of the shipping address that the new items should be sent to.
- x-expandable: shipping_address
- nullable: true
- $ref: '#/components/schemas/Address'
- shipping_methods:
- description: The details of the shipping methods used to fulfill the additional items purchased.
- type: array
- x-expandable: shipping_methods
- items:
- $ref: '#/components/schemas/ShippingMethod'
- cart_id:
- description: The ID of the cart that the customer uses to complete the swap.
- nullable: true
- type: string
- example: cart_01G8ZH853Y6TFXWPG5EYE81X63
- cart:
- description: The details of the cart that the customer uses to complete the swap.
- x-expandable: cart
- nullable: true
- type: object
- confirmed_at:
- description: The date with timezone at which the Swap was confirmed by the Customer.
- nullable: true
- type: string
- format: date-time
- canceled_at:
- description: The date with timezone at which the Swap was canceled.
- nullable: true
- type: string
- format: date-time
- no_notification:
- description: If set to true, no notification will be sent related to this swap
- nullable: true
- type: boolean
- example: false
- allow_backorder:
- description: If true, swaps can be completed with items out of stock
- type: boolean
- default: false
- idempotency_key:
- description: Randomly generated key used to continue the completion of the swap in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- TaxLine:
- title: Tax Line
- description: A tax line represents the taxes amount applied to a line item.
- type: object
- required:
- - code
- - created_at
- - id
- - metadata
- - name
- - rate
- - updated_at
- properties:
- id:
- description: The tax line's ID
- type: string
- example: tl_01G1G5V2DRX1SK6NQQ8VVX4HQ8
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- rate:
- description: The numeric rate to charge tax by
- type: number
- example: 10
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- TaxProvider:
- title: Tax Provider
- description: A tax provider represents a tax service installed in the Medusa backend, either through a plugin or backend customizations. It holds the tax service's installation status.
- type: object
- required:
- - id
- - is_installed
- properties:
- id:
- description: The ID of the tax provider as given by the tax service.
- type: string
- example: manual
- is_installed:
- description: Whether the tax service is installed in the current version. If a tax service is no longer installed, the `is_installed` attribute is set to `false`.
- type: boolean
- default: true
- TaxRate:
- title: Tax Rate
- description: A Tax Rate can be used to define a custom rate to charge on specified products, product types, and shipping options within a given region.
- type: object
- required:
- - code
- - created_at
- - id
- - metadata
- - name
- - rate
- - region_id
- - updated_at
- properties:
- id:
- description: The tax rate's ID
- type: string
- example: txr_01G8XDBAWKBHHJRKH0AV02KXBR
- rate:
- description: The numeric rate to charge
- nullable: true
- type: number
- example: 10
- code:
- description: A code to identify the tax type by
- nullable: true
- type: string
- example: tax01
- name:
- description: A human friendly name for the tax
- type: string
- example: Tax Example
- region_id:
- description: The ID of the region that the rate belongs to.
- type: string
- example: reg_01G1G5V26T9H8Y0M4JNE3YGA4G
- region:
- description: The details of the region that the rate belongs to.
- x-expandable: region
- nullable: true
- type: object
- products:
- description: The details of the products that belong to this tax rate.
- type: array
- x-expandable: products
- items:
- $ref: '#/components/schemas/Product'
- product_types:
- description: The details of the product types that belong to this tax rate.
- type: array
- x-expandable: product_types
- items:
- $ref: '#/components/schemas/ProductType'
- shipping_options:
- description: The details of the shipping options that belong to this tax rate.
- type: array
- x-expandable: shipping_options
- items:
- $ref: '#/components/schemas/ShippingOption'
- product_count:
- description: The count of products
- type: integer
- example: 10
- product_type_count:
- description: The count of product types
- type: integer
- example: 2
- shipping_option_count:
- description: The count of shipping options
- type: integer
- example: 1
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- TrackingLink:
- title: Tracking Link
- description: A tracking link holds information about tracking numbers for a Fulfillment. Tracking Links can optionally contain a URL that can be visited to see the status of the shipment. Typically, the tracking link is provided from the third-party service integrated through the used fulfillment provider.
- type: object
- required:
- - created_at
- - deleted_at
- - fulfillment_id
- - id
- - idempotency_key
- - metadata
- - tracking_number
- - updated_at
- - url
- properties:
- id:
- description: The tracking link's ID
- type: string
- example: tlink_01G8ZH853Y6TFXWPG5EYE81X63
- url:
- description: The URL at which the status of the shipment can be tracked.
- nullable: true
- type: string
- format: uri
- tracking_number:
- description: The tracking number given by the shipping carrier.
- type: string
- format: RH370168054CN
- fulfillment_id:
- description: The ID of the fulfillment that the tracking link belongs to.
- type: string
- example: ful_01G8ZRTMQCA76TXNAT81KPJZRF
- fulfillment:
- description: The details of the fulfillment that the tracking link belongs to.
- x-expandable: fulfillment
- nullable: true
- type: object
- idempotency_key:
- description: Randomly generated key used to continue the completion of a process in case of failure.
- nullable: true
- type: string
- externalDocs:
- url: https://docs.medusajs.com/development/idempotency-key/overview.md
- description: Learn more how to use the idempotency key.
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
- UpdateStockLocationInput:
- title: Update Stock Location Input
- description: Represents the Input to update a Stock Location
- type: object
- properties:
- name:
- type: string
- description: The stock location name
- address_id:
- type: string
- description: The Stock location address ID
- address:
- description: Stock location address object
- allOf:
- - $ref: '#/components/schemas/StockLocationAddressInput'
- - type: object
- metadata:
- type: object
- description: An optional key-value map with additional details
- example:
- car: white
- User:
- title: User
- description: A User is an administrator who can manage store settings and data.
- type: object
- required:
- - api_token
- - created_at
- - deleted_at
- - email
- - first_name
- - id
- - last_name
- - metadata
- - role
- - updated_at
- properties:
- id:
- description: The user's ID
- type: string
- example: usr_01G1G5V26F5TB3GPAPNJ8X1S3V
- role:
- description: The user's role. These roles don't provide any different privileges.
- type: string
- enum:
- - admin
- - member
- - developer
- default: member
- email:
- description: The email of the User
- type: string
- format: email
- first_name:
- description: The first name of the User
- nullable: true
- type: string
- example: Levi
- last_name:
- description: The last name of the User
- nullable: true
- type: string
- example: Bogan
- api_token:
- description: An API token associated with the user.
- nullable: true
- type: string
- example: null
- created_at:
- description: The date with timezone at which the resource was created.
- type: string
- format: date-time
- updated_at:
- description: The date with timezone at which the resource was updated.
- type: string
- format: date-time
- deleted_at:
- description: The date with timezone at which the resource was deleted.
- nullable: true
- type: string
- format: date-time
- metadata:
- description: An optional key-value map with additional details
- nullable: true
- type: object
- example:
- car: white
- externalDocs:
- description: Learn about the metadata attribute, and how to delete and update it.
- url: https://docs.medusajs.com/development/entities/overview#metadata-attribute
+ description: The payment collection's data.
+ properties: {}
diff --git a/www/apps/api-reference/specs/store/openapi.yaml b/www/apps/api-reference/specs/store/openapi.yaml
index 3811f07124..e7588daca6 100644
--- a/www/apps/api-reference/specs/store/openapi.yaml
+++ b/www/apps/api-reference/specs/store/openapi.yaml
@@ -1,6 +1,6 @@
openapi: 3.0.0
info:
- version: 1.0.0
+ version: 2.0.0
title: Medusa Storefront API
license:
name: MIT
@@ -9,17 +9,6 @@ servers:
- url: http://localhost:9000
- url: https://api.medusa-commerce.com
tags:
- - name: Auth
- description: >
- Authentication API Routes allow you to manage a customer's session, such
- as login or log out.
-
- You can send authenticated requests for a customer either using the Cookie
- header or using the JWT Token.
- externalDocs:
- description: How to implement customer profiles in your storefront
- url: >-
- https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
- name: Carts
description: >
A cart is a virtual shopping bag that customers can use to add items they
@@ -30,6 +19,7 @@ tags:
description: How to implement cart functionality in your storefront
url: >-
https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-cart
+ - name: Currencies
- name: Customers
description: >
A customer can register and manage their information such as addresses,
@@ -38,81 +28,10 @@ tags:
description: How to implement customer profiles in your storefront
url: >-
https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles
- - name: Gift Cards
- description: >
- Customers can use gift cards during checkout to deduct the gift card's
- balance from the checkout total.
-
- The Gift Card API Routes allow retrieving a gift card's details by its
- code. A gift card can be applied to a cart using the Carts API Routes.
- externalDocs:
- description: How to use gift cards in a storefront
- url: https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards
- - name: Orders
- description: >
- Orders are purchases made by customers, typically through a storefront.
-
- Orders are placed and created using the Carts API Routes. The Orders API
- Routes allow retrieving and claiming orders.
- externalDocs:
- description: How to retrieve order details in a storefront
- url: >-
- https://docs.medusajs.com/modules/orders/storefront/retrieve-order-details
- - name: Order Edits
- description: >
- Order edits are changes made to items in an order such as adding, updating
- their quantity, or deleting them. Order edits are created by the admin.
-
- A customer can review order edit requests created by an admin and confirm
- or decline them.
- externalDocs:
- description: How to handle order edits in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/handle-order-edits
- name: Payment Collections
description: >
A payment collection is useful for managing additional payments, such as
for Order Edits, or installment payments.
- - name: Products
- description: >
- Products are saleable items in a store. This also includes [saleable gift
- cards](https://docs.medusajs.com/modules/gift-cards/storefront/use-gift-cards)
- in a store.
-
- Using these API Routes, you can filter products by categories,
- collections, sales channels, and more.
- externalDocs:
- description: How to show products in a storefront
- url: https://docs.medusajs.com/modules/products/storefront/show-products
- - name: Product Variants
- description: >
- Product variants are the actual salable item in your store. Each variant
- is a combination of the different option values available on the product.
- - name: Product Categories
- description: >
- Products can be categoriezed into categories. A product can be associated
- more than one category.
-
- Using these API Routes, you can list or retrieve a category's details and
- products.
- externalDocs:
- description: How to use product categories in a storefront
- url: https://docs.medusajs.com/modules/products/storefront/use-categories
- - name: Product Collections
- description: >
- A product collection is used to organize products for different purposes
- such as marketing or discount purposes. For example, you can create a
- Summer Collection.
-
- Using these API Routes, you can list or retrieve a collection's details
- and products.
- - name: Product Tags
- description: |
- Product tags are string values that can be used to filter products by.
- Products can have more than one tag, and products can share tags.
- - name: Product Types
- description: |
- Product types are string values that can be used to filter products by.
- Products can have more than one tag, and products can share types.
- name: Regions
description: >
Regions are different countries or geographical regions that the commerce
@@ -124,16 +43,6 @@ tags:
description: How to use regions in a storefront
url: >-
https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
- - name: Returns
- description: |
- A return can be created by a customer to return items in an order.
- externalDocs:
- description: How to create a return in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/create-return
- - name: Return Reasons
- description: >
- Return reasons are key-value pairs that are used to specify why an order
- return is being created.
- name: Shipping Options
description: >
A shipping option is used to define the available shipping methods during
@@ -142,51 +51,25 @@ tags:
description: Shipping Option architecture
url: >-
https://docs.medusajs.com/modules/carts-and-checkout/shipping#shipping-option
- - name: Swaps
- description: >
- A swap is created by a customer or an admin to exchange an item with a new
- one.
-
- Creating a swap implicitely includes creating a return for the item being
- exchanged.
- externalDocs:
- description: How to create a swap in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/create-swap
paths:
- /store/auth:
- $ref: paths/store_auth.yaml
- /store/auth/token:
- $ref: paths/store_auth_token.yaml
- /store/auth/{email}:
- $ref: paths/store_auth_{email}.yaml
/store/carts:
$ref: paths/store_carts.yaml
/store/carts/{id}:
$ref: paths/store_carts_{id}.yaml
- /store/carts/{id}/complete:
- $ref: paths/store_carts_{id}_complete.yaml
- /store/carts/{id}/discounts/{code}:
- $ref: paths/store_carts_{id}_discounts_{code}.yaml
/store/carts/{id}/line-items:
$ref: paths/store_carts_{id}_line-items.yaml
/store/carts/{id}/line-items/{line_id}:
$ref: paths/store_carts_{id}_line-items_{line_id}.yaml
- /store/carts/{id}/payment-session:
- $ref: paths/store_carts_{id}_payment-session.yaml
- /store/carts/{id}/payment-sessions:
- $ref: paths/store_carts_{id}_payment-sessions.yaml
- /store/carts/{id}/payment-sessions/{provider_id}:
- $ref: paths/store_carts_{id}_payment-sessions_{provider_id}.yaml
- /store/carts/{id}/payment-sessions/{provider_id}/refresh:
- $ref: paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml
- /store/carts/{id}/shipping-methods:
- $ref: paths/store_carts_{id}_shipping-methods.yaml
+ /store/carts/{id}/payment-collections:
+ $ref: paths/store_carts_{id}_payment-collections.yaml
+ /store/carts/{id}/promotions:
+ $ref: paths/store_carts_{id}_promotions.yaml
/store/carts/{id}/taxes:
$ref: paths/store_carts_{id}_taxes.yaml
- /store/collections:
- $ref: paths/store_collections.yaml
- /store/collections/{id}:
- $ref: paths/store_collections_{id}.yaml
+ /store/currencies:
+ $ref: paths/store_currencies.yaml
+ /store/currencies/{code}:
+ $ref: paths/store_currencies_{code}.yaml
/store/customers:
$ref: paths/store_customers.yaml
/store/customers/me:
@@ -195,80 +78,16 @@ paths:
$ref: paths/store_customers_me_addresses.yaml
/store/customers/me/addresses/{address_id}:
$ref: paths/store_customers_me_addresses_{address_id}.yaml
- /store/customers/me/orders:
- $ref: paths/store_customers_me_orders.yaml
- /store/customers/me/payment-methods:
- $ref: paths/store_customers_me_payment-methods.yaml
- /store/customers/password-reset:
- $ref: paths/store_customers_password-reset.yaml
- /store/customers/password-token:
- $ref: paths/store_customers_password-token.yaml
- /store/gift-cards/{code}:
- $ref: paths/store_gift-cards_{code}.yaml
- /store/order-edits/{id}:
- $ref: paths/store_order-edits_{id}.yaml
- /store/order-edits/{id}/complete:
- $ref: paths/store_order-edits_{id}_complete.yaml
- /store/order-edits/{id}/decline:
- $ref: paths/store_order-edits_{id}_decline.yaml
- /store/orders:
- $ref: paths/store_orders.yaml
- /store/orders/batch/customer/token:
- $ref: paths/store_orders_batch_customer_token.yaml
- /store/orders/cart/{cart_id}:
- $ref: paths/store_orders_cart_{cart_id}.yaml
- /store/orders/customer/confirm:
- $ref: paths/store_orders_customer_confirm.yaml
- /store/orders/{id}:
- $ref: paths/store_orders_{id}.yaml
- /store/payment-collections/{id}:
- $ref: paths/store_payment-collections_{id}.yaml
- /store/payment-collections/{id}/sessions:
- $ref: paths/store_payment-collections_{id}_sessions.yaml
- /store/payment-collections/{id}/sessions/batch:
- $ref: paths/store_payment-collections_{id}_sessions_batch.yaml
- /store/payment-collections/{id}/sessions/batch/authorize:
- $ref: paths/store_payment-collections_{id}_sessions_batch_authorize.yaml
- /store/payment-collections/{id}/sessions/{session_id}:
- $ref: paths/store_payment-collections_{id}_sessions_{session_id}.yaml
- /store/payment-collections/{id}/sessions/{session_id}/authorize:
- $ref: paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml
- /store/product-categories:
- $ref: paths/store_product-categories.yaml
- /store/product-categories/{id}:
- $ref: paths/store_product-categories_{id}.yaml
- /store/product-tags:
- $ref: paths/store_product-tags.yaml
- /store/product-types:
- $ref: paths/store_product-types.yaml
- /store/products:
- $ref: paths/store_products.yaml
- /store/products/search:
- $ref: paths/store_products_search.yaml
- /store/products/{id}:
- $ref: paths/store_products_{id}.yaml
+ /store/payment-collections/{id}/payment-sessions:
+ $ref: paths/store_payment-collections_{id}_payment-sessions.yaml
/store/regions:
$ref: paths/store_regions.yaml
/store/regions/{id}:
$ref: paths/store_regions_{id}.yaml
- /store/return-reasons:
- $ref: paths/store_return-reasons.yaml
- /store/return-reasons/{id}:
- $ref: paths/store_return-reasons_{id}.yaml
- /store/returns:
- $ref: paths/store_returns.yaml
- /store/shipping-options:
- $ref: paths/store_shipping-options.yaml
+ /store/regions/{id}/payment-providers:
+ $ref: paths/store_regions_{id}_payment-providers.yaml
/store/shipping-options/{cart_id}:
$ref: paths/store_shipping-options_{cart_id}.yaml
- /store/swaps:
- $ref: paths/store_swaps.yaml
- /store/swaps/{cart_id}:
- $ref: paths/store_swaps_{cart_id}.yaml
- /store/variants:
- $ref: paths/store_variants.yaml
- /store/variants/{id}:
- $ref: paths/store_variants_{id}.yaml
components:
securitySchemes:
jwt_token:
diff --git a/www/apps/api-reference/specs/store/paths/store_auth.yaml b/www/apps/api-reference/specs/store/paths/store_auth.yaml
deleted file mode 100644
index 5f230011df..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_auth.yaml
+++ /dev/null
@@ -1,121 +0,0 @@
-get:
- operationId: GetAuth
- summary: Get Current Customer
- description: Retrieve the currently logged in Customer's details.
- x-authenticated: true
- x-codegen:
- method: getSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_auth/get.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_auth/get.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreAuthRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
-post:
- operationId: PostAuth
- summary: Customer Login
- description: >-
- Log a customer in and includes the Cookie session in the response header.
- The cookie session can be used in subsequent requests to authenticate the
- customer. When using Medusa's JS or Medusa React clients, the cookie is
- automatically attached to subsequent requests.
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostAuthReq.yaml
- x-codegen:
- method: authenticate
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_auth/post.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_auth/post.sh
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreAuthRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/incorrect_credentials.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
-delete:
- operationId: DeleteAuth
- summary: Customer Log out
- description: Delete the current session for the logged in customer.
- x-authenticated: true
- x-codegen:
- method: deleteSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_auth/delete.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_auth/delete.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Auth
- responses:
- '200':
- description: OK
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_auth_token.yaml b/www/apps/api-reference/specs/store/paths/store_auth_token.yaml
deleted file mode 100644
index df6f066bb5..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_auth_token.yaml
+++ /dev/null
@@ -1,44 +0,0 @@
-post:
- operationId: PostToken
- summary: Customer Login (JWT)
- x-authenticated: false
- description: >-
- After a successful login, a JWT token is returned, which can be used to send
- authenticated requests.
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostAuthReq.yaml
- x-codegen:
- method: getToken
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_auth_token/post.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_auth_token/post.sh
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreBearerAuthRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/incorrect_credentials.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_auth_{email}.yaml b/www/apps/api-reference/specs/store/paths/store_auth_{email}.yaml
deleted file mode 100644
index 9b1b2ac50d..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_auth_{email}.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-get:
- operationId: GetAuthEmail
- summary: Check if Email Exists
- description: Check if there's a customer already registered with the provided email.
- parameters:
- - in: path
- name: email
- schema:
- type: string
- format: email
- required: true
- description: The email to check.
- x-codegen:
- method: exists
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_auth_{email}/get.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_auth_{email}/get.sh
- tags:
- - Auth
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreGetAuthEmailRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts.yaml b/www/apps/api-reference/specs/store/paths/store_carts.yaml
index fe36954e14..b3c9f70118 100644
--- a/www/apps/api-reference/specs/store/paths/store_carts.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml
@@ -1,33 +1,10 @@
post:
- operationId: PostCart
- summary: Create a Cart
- description: >
- Create a Cart. Although optional, specifying the cart's region and sales
- channel can affect the cart's pricing and
-
- the products that can be added to the cart respectively. So, make sure to
- set those early on and change them if necessary, such as when the customer
- changes their region.
-
-
- If a customer is logged in, make sure to pass its ID or email within the
- cart's details so that the cart is attached to the customer.
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCartReq.yaml
- x-codegen:
- method: create
+ operationId: PostCarts
+ summary: Create Cart
+ description: Create a cart.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts/post.tsx
- lang: Shell
label: cURL
source:
@@ -35,14 +12,10 @@ post:
tags:
- Carts
responses:
- '200':
- description: Successfully created a new Cart
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -51,3 +24,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
index f64f7415c8..6c7ff10d87 100644
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml
@@ -1,25 +1,18 @@
get:
- operationId: GetCartsCart
+ operationId: GetCartsId
summary: Get a Cart
- description: Retrieve a Cart's details. This includes recalculating its totals.
+ description: >-
+ Retrieve a cart by its ID. You can expand the cart's relations or select the
+ fields that should be returned.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The cart's ID.
required: true
- description: The ID of the Cart.
schema:
type: string
- x-codegen:
- method: retrieve
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}/get.tsx
- lang: Shell
label: cURL
source:
@@ -27,14 +20,10 @@ get:
tags:
- Carts
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -43,36 +32,23 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
-post:
- operationId: PostCartsCart
- summary: Update a Cart
- description: >-
- Update a Cart's details. If the cart has payment sessions and the region was
- not changed, the payment sessions are updated. The cart's totals are also
- recalculated.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
requestBody:
content:
application/json:
- schema:
- $ref: ../components/schemas/StorePostCartsCartReq.yaml
- x-codegen:
- method: update
+ schema: {}
+post:
+ operationId: PostCartsId
+ summary: Update a Cart
+ description: Update a cart's details.
+ x-authenticated: false
+ parameters:
+ - name: id
+ in: path
+ description: The cart's ID.
+ required: true
+ schema:
+ type: string
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}/post.tsx
- lang: Shell
label: cURL
source:
@@ -80,14 +56,10 @@ post:
tags:
- Carts
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -96,3 +68,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
deleted file mode 100644
index 999000b60c..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml
+++ /dev/null
@@ -1,69 +0,0 @@
-post:
- summary: Complete a Cart
- operationId: PostCartsCartComplete
- description: >
- Complete a cart and place an order or create a swap, based on the cart's
- type. This includes attempting to authorize the cart's payment.
-
- If authorizing the payment requires more action, the cart will not be
- completed and the order will not be placed or the swap will not be created.
-
-
- An idempotency key will be generated if none is provided in the header
- `Idempotency-Key` and added to
-
- the response. If an error occurs during cart completion or the request is
- interrupted for any reason, the cart completion can be retried by passing
- the idempotency
-
- key in the `Idempotency-Key` header.
- externalDocs:
- description: Cart completion overview
- url: https://docs.medusajs.com/modules/carts-and-checkout/cart#cart-completion
- parameters:
- - in: path
- name: id
- required: true
- description: The Cart ID.
- schema:
- type: string
- x-codegen:
- method: complete
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}_complete/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_complete/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_carts_{id}_complete/post.sh
- tags:
- - Carts
- responses:
- '200':
- description: >-
- If the payment of the cart was successfully authorized, but requires
- further action from the customer, the response body will contain the
- cart with an updated payment session. Otherwise, if the payment was
- authorized and the cart was successfully completed, the response body
- will contain either the newly created order or swap, depending on what
- the cart was created for.
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCompleteCartRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml
deleted file mode 100644
index e89f14a946..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_discounts_{code}.yaml
+++ /dev/null
@@ -1,50 +0,0 @@
-delete:
- operationId: DeleteCartsCartDiscountsDiscount
- summary: Remove Discount
- description: >-
- Remove a Discount from a Cart. This only removes the application of the
- discount, and not completely deletes it. The totals will be re-calculated
- and the payment sessions will be refreshed after the removal.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
- - in: path
- name: code
- required: true
- description: The unique discount code.
- schema:
- type: string
- x-codegen:
- method: deleteDiscount
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}_discounts_{code}/delete.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_carts_{id}_discounts_{code}/delete.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
index d3c6533c7d..c821f142a0 100644
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items.yaml
@@ -1,30 +1,16 @@
post:
- operationId: PostCartsCartLineItems
- summary: Add a Line Item
- description: Generates a Line Item with a given Product Variant and adds it to the Cart
+ operationId: PostCartsIdLineItems
+ summary: Add Line Items to Cart
+ description: Add a list of line items to a cart.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The cart's ID.
required: true
- description: The id of the Cart to add the Line Item to.
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCartsCartLineItemsReq.yaml
- x-codegen:
- method: createLineItem
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}_line-items/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_line-items/post.tsx
- lang: Shell
label: cURL
source:
@@ -32,14 +18,10 @@ post:
tags:
- Carts
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -48,3 +30,7 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
index 1478eb81ea..eb41b93406 100644
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml
@@ -1,37 +1,22 @@
post:
- operationId: PostCartsCartLineItemsItem
- summary: Update a Line Item
- description: Update a line item's quantity.
+ operationId: PostCartsIdLineItemsLine_id
+ summary: Add Line Items to Cart
+ description: Add a list of line items to a cart.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The cart's ID.
required: true
- description: The ID of the Cart.
schema:
type: string
- - in: path
- name: line_id
+ - name: line_id
+ in: path
+ description: The cart's line id.
required: true
- description: The ID of the Line Item.
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCartsCartLineItemsItemReq.yaml
- x-codegen:
- method: updateLineItem
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/post.tsx
- lang: Shell
label: cURL
source:
@@ -39,14 +24,10 @@ post:
tags:
- Carts
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -55,37 +36,31 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
delete:
- operationId: DeleteCartsCartLineItemsItem
- summary: Delete a Line Item
+ operationId: DeleteCartsIdLineItemsLine_id
+ summary: Remove Line Items from Cart
description: >-
- Delete a Line Item from a Cart. The payment sessions will be updated and the
- totals will be recalculated.
+ Remove a list of line items from a cart. This doesn't delete the Line Item,
+ only the association between the Line Item and the cart.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The cart's ID.
required: true
- description: The ID of the Cart.
schema:
type: string
- - in: path
- name: line_id
+ - name: line_id
+ in: path
+ description: The cart's line id.
required: true
- description: The ID of the Line Item.
schema:
type: string
- x-codegen:
- method: deleteLineItem
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_carts_{id}_line-items_{line_id}/delete.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_line-items_{line_id}/delete.tsx
- lang: Shell
label: cURL
source:
@@ -93,14 +68,10 @@ delete:
tags:
- Carts
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -109,3 +80,7 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs-v2/store/paths/store_carts_{id}_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-collections.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/paths/store_carts_{id}_payment-collections.yaml
rename to www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-collections.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml
deleted file mode 100644
index 3b2bbff0dd..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-session.yaml
+++ /dev/null
@@ -1,53 +0,0 @@
-post:
- operationId: PostCartsCartPaymentSession
- summary: Select a Payment Session
- description: >-
- Select the Payment Session that will be used to complete the cart. This is
- typically used when the customer chooses their preferred payment method
- during checkout. The totals of the cart will be recalculated.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCartsCartPaymentSessionReq.yaml
- x-codegen:
- method: setPaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}_payment-session/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_payment-session/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_carts_{id}_payment-session/post.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml
deleted file mode 100644
index 73aaef6c07..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions.yaml
+++ /dev/null
@@ -1,49 +0,0 @@
-post:
- operationId: PostCartsCartPaymentSessions
- summary: Create Payment Sessions
- description: >-
- Create Payment Sessions for each of the available Payment Providers in the
- Cart's Region. If there's only one payment session created, it will be
- selected by default. The creation of the payment session uses the payment
- provider and may require sending requests to third-party services.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
- x-codegen:
- method: createPaymentSessions
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}_payment-sessions/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_payment-sessions/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_carts_{id}_payment-sessions/post.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml
deleted file mode 100644
index a1c3285a73..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}.yaml
+++ /dev/null
@@ -1,120 +0,0 @@
-post:
- operationId: PostCartsCartPaymentSessionUpdate
- summary: Update a Payment Session
- description: >-
- Update a Payment Session with additional data. This can be useful depending
- on the payment provider used. All payment sessions are updated and cart
- totals are recalculated afterwards.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
- - in: path
- name: provider_id
- required: true
- description: The ID of the payment provider.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCartsCartPaymentSessionUpdateReq.yaml
- x-codegen:
- method: updatePaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/post.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
-delete:
- operationId: DeleteCartsCartPaymentSessionsSession
- summary: Delete a Payment Session
- description: >-
- Delete a Payment Session in a Cart. May be useful if a payment has failed.
- The totals will be recalculated.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
- - in: path
- name: provider_id
- required: true
- description: >-
- The ID of the Payment Provider used to create the Payment Session to be
- deleted.
- schema:
- type: string
- x-codegen:
- method: deletePaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}/delete.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}/delete.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}/delete.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml
deleted file mode 100644
index d7090b15dc..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_payment-sessions_{provider_id}_refresh.yaml
+++ /dev/null
@@ -1,58 +0,0 @@
-post:
- operationId: PostCartsCartPaymentSessionsSession
- summary: Refresh a Payment Session
- description: >-
- Refresh a Payment Session to ensure that it is in sync with the Cart. This
- is usually not necessary, but is provided for edge cases.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Cart.
- schema:
- type: string
- - in: path
- name: provider_id
- required: true
- description: >-
- The ID of the Payment Provider that created the Payment Session to be
- refreshed.
- schema:
- type: string
- x-codegen:
- method: refreshPaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_carts_{id}_payment-sessions_{provider_id}_refresh/post.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs-v2/store/paths/store_carts_{id}_promotions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/paths/store_carts_{id}_promotions.yaml
rename to www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
deleted file mode 100644
index e3fee76747..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml
+++ /dev/null
@@ -1,52 +0,0 @@
-post:
- operationId: PostCartsCartShippingMethod
- summary: Add Shipping Method
- description: >-
- Add a Shipping Method to the Cart. The validation of the `data` field is
- handled by the fulfillment provider of the chosen shipping option.
- parameters:
- - in: path
- name: id
- required: true
- description: The cart ID.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCartsCartShippingMethodReq.yaml
- x-codegen:
- method: addShippingMethod
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_carts_{id}_shipping-methods/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_carts_{id}_shipping-methods/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_carts_{id}_shipping-methods/post.sh
- tags:
- - Carts
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
index fd002e7f31..b682bfc374 100644
--- a/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}_taxes.yaml
@@ -1,23 +1,20 @@
post:
- operationId: PostCartsCartTaxes
- summary: Calculate Cart Taxes
- description: >-
- Calculate the taxes for a cart. This is useful if the `automatic_taxes`
- field of the cart's region is set to `false`. If the cart's region uses a
- tax provider other than Medusa's system provider, this may lead to sending
- requests to third-party services.
- externalDocs:
- description: How to calculate taxes manually during checkout
- url: https://docs.medusajs.com/modules/taxes/storefront/manual-calculation
+ operationId: PostCartsIdTaxes
+ summary: Add Taxes to Cart
+ description: Add a list of taxes to a cart.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The cart's ID.
required: true
- description: The Cart ID.
schema:
type: string
- x-codegen:
- method: calculateTaxes
+ requestBody:
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/StorePostCartsCartTaxesReq.yaml
x-codeSamples:
- lang: Shell
label: cURL
@@ -26,14 +23,10 @@ post:
tags:
- Carts
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
diff --git a/www/apps/api-reference/specs/store/paths/store_collections.yaml b/www/apps/api-reference/specs/store/paths/store_collections.yaml
deleted file mode 100644
index e798d10141..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_collections.yaml
+++ /dev/null
@@ -1,110 +0,0 @@
-get:
- operationId: GetCollections
- summary: List Collections
- description: >-
- Retrieve a list of product collections. The product collections can be
- filtered by fields such as `handle` or `created_at`. The product collections
- can also be paginated.
- parameters:
- - in: query
- name: offset
- description: >-
- The number of product collections to skip when retrieving the product
- collections.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of product collections returned.
- schema:
- type: integer
- default: 10
- - in: query
- name: handle
- style: form
- explode: false
- description: Filter by handles
- schema:
- type: array
- items:
- type: string
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- x-codegen:
- method: list
- queryParams: StoreGetCollectionsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_collections/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_collections/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_collections/get.sh
- tags:
- - Product Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCollectionsListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
deleted file mode 100644
index f417830db6..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_collections_{id}.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-get:
- operationId: GetCollectionsCollection
- summary: Get a Collection
- description: Retrieve a Product Collection's details.
- parameters:
- - in: path
- name: id
- required: true
- description: The id of the Product Collection
- schema:
- type: string
- x-codegen:
- method: retrieve
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_collections_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_collections_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_collections_{id}/get.sh
- tags:
- - Product Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCollectionsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs-v2/store/paths/store_currencies.yaml b/www/apps/api-reference/specs/store/paths/store_currencies.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/paths/store_currencies.yaml
rename to www/apps/api-reference/specs/store/paths/store_currencies.yaml
diff --git a/www/apps/api-reference/specs-v2/store/paths/store_currencies_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/paths/store_currencies_{code}.yaml
rename to www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml
index 4066cea147..26ff1861ee 100644
--- a/www/apps/api-reference/specs/store/paths/store_customers.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml
@@ -1,28 +1,10 @@
post:
operationId: PostCustomers
- summary: Create a Customer
- description: >-
- Register a new customer. This will also automatically authenticate the
- customer and set their login session in the response Cookie header. The
- cookie session can be used in subsequent requests to authenticate the
- customer. When using Medusa's JS or Medusa React clients, the cookie is
- automatically attached to subsequent requests.
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCustomersReq.yaml
- x-codegen:
- method: create
+ summary: Create Customer
+ description: Create a customer.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_customers/post.tsx
- lang: Shell
label: cURL
source:
@@ -30,39 +12,19 @@ post:
tags:
- Customers
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
- description: A customer with the same email exists
- content:
- application/json:
- schema:
- type: object
- properties:
- code:
- type: string
- description: The error code
- type:
- type: string
- description: The type of error
- message:
- type: string
- description: Human-readable message with details about the error
- example:
- code: invalid_request_error
- type: duplicate_error
- message: >-
- A customer with the given email already has an account. Log in
- instead
+ $ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml
index c47ff60add..f4fa33b2b6 100644
--- a/www/apps/api-reference/specs/store/paths/store_customers_me.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers_me.yaml
@@ -1,35 +1,19 @@
get:
- operationId: GetCustomersCustomer
- summary: Get a Customer
- description: Retrieve the logged-in Customer's details.
- x-authenticated: true
- x-codegen:
- method: retrieve
+ operationId: GetCustomersMe
+ summary: List Customers
+ description: >-
+ Retrieve a list of customers. The customers can be filtered by fields such
+ as `id`. The customers can also be sorted or paginated.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_me/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_customers_me/get.tsx
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/store_customers_me/get.sh
- security:
- - cookie_auth: []
- - jwt_token: []
tags:
- Customers
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -42,52 +26,7 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
-post:
- operationId: PostCustomersCustomer
- summary: Update Customer
- description: Update the logged-in customer's details.
- x-authenticated: true
requestBody:
content:
application/json:
- schema:
- $ref: ../components/schemas/StorePostCustomersCustomerReq.yaml
- x-codegen:
- method: update
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_me/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_customers_me/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_customers_me/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Customers
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
index 685ddfbea9..d993417ab0 100644
--- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml
@@ -1,36 +1,19 @@
-post:
- operationId: PostCustomersCustomerAddresses
- summary: Add a Shipping Address
- description: Add a Shipping Address to a Customer's saved addresses.
- x-authenticated: true
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCustomersCustomerAddressesReq.yaml
- x-codegen:
- method: addAddress
+get:
+ operationId: GetCustomersMeAddresses
+ summary: List Customers
+ description: >-
+ Retrieve a list of customers. The customers can be filtered by fields such
+ as `id`. The customers can also be sorted or paginated.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_me_addresses/post.js
- lang: Shell
label: cURL
source:
- $ref: ../code_samples/Shell/store_customers_me_addresses/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
+ $ref: ../code_samples/Shell/store_customers_me_addresses/get.sh
tags:
- Customers
responses:
- '200':
- description: A successful response
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -43,3 +26,37 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
+post:
+ operationId: PostCustomersMeAddresses
+ summary: Create Customer
+ description: Create a customer.
+ x-authenticated: false
+ parameters: []
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/store_customers_me_addresses/post.sh
+ tags:
+ - Customers
+ responses:
+ '400':
+ $ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
+ '404':
+ $ref: ../components/responses/not_found_error.yaml
+ '409':
+ $ref: ../components/responses/invalid_state_error.yaml
+ '422':
+ $ref: ../components/responses/invalid_request_error.yaml
+ '500':
+ $ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
index d52aaaedd4..cd34e7826b 100644
--- a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses_{address_id}.yaml
@@ -1,46 +1,62 @@
-post:
- operationId: PostCustomersCustomerAddressesAddress
- summary: Update a Shipping Address
- description: Update the logged-in customer's saved Shipping Address's details.
- x-authenticated: true
+get:
+ operationId: GetCustomersMeAddressesAddress_id
+ summary: List Addresses
+ description: >-
+ Retrieve a list of addresses in a customer. The addresses can be filtered by
+ fields like FILTER FIELDS. The addresses can also be paginated.
+ x-authenticated: false
parameters:
- - in: path
- name: address_id
+ - name: address_id
+ in: path
+ description: The customer's address id.
required: true
- description: The ID of the Address.
schema:
type: string
+ x-codeSamples:
+ - lang: Shell
+ label: cURL
+ source:
+ $ref: ../code_samples/Shell/store_customers_me_addresses_{address_id}/get.sh
+ tags:
+ - Customers
+ responses:
+ '400':
+ $ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
+ '404':
+ $ref: ../components/responses/not_found_error.yaml
+ '409':
+ $ref: ../components/responses/invalid_state_error.yaml
+ '422':
+ $ref: ../components/responses/invalid_request_error.yaml
+ '500':
+ $ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
- schema:
- $ref: >-
- ../components/schemas/StorePostCustomersCustomerAddressesAddressReq.yaml
- x-codegen:
- method: updateAddress
+ schema: {}
+post:
+ operationId: PostCustomersMeAddressesAddress_id
+ summary: Add Addresses to Customer
+ description: Add a list of addresses to a customer.
+ x-authenticated: false
+ parameters:
+ - name: address_id
+ in: path
+ description: The customer's address id.
+ required: true
+ schema:
+ type: string
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_customers_me_addresses_{address_id}/post.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/store_customers_me_addresses_{address_id}/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
tags:
- Customers
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -53,43 +69,33 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
delete:
- operationId: DeleteCustomersCustomerAddressesAddress
- summary: Delete an Address
- description: Delete an Address from the Customer's saved addresses.
- x-authenticated: true
+ operationId: DeleteCustomersMeAddressesAddress_id
+ summary: Remove Addresses from Customer
+ description: >-
+ Remove a list of addresses from a customer. This doesn't delete the Address,
+ only the association between the Address and the customer.
+ x-authenticated: false
parameters:
- - in: path
- name: address_id
+ - name: address_id
+ in: path
+ description: The customer's address id.
required: true
- description: The id of the Address to remove.
schema:
type: string
- x-codegen:
- method: deleteAddress
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_customers_me_addresses_{address_id}/delete.js
- lang: Shell
label: cURL
source:
$ref: >-
../code_samples/Shell/store_customers_me_addresses_{address_id}/delete.sh
- security:
- - cookie_auth: []
- - jwt_token: []
tags:
- Customers
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -102,3 +108,7 @@ delete:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml
deleted file mode 100644
index 5939bc14b4..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_customers_me_orders.yaml
+++ /dev/null
@@ -1,238 +0,0 @@
-get:
- operationId: GetCustomersCustomerOrders
- summary: List Orders
- description: >-
- Retrieve a list of the logged-in Customer's Orders. The orders can be
- filtered by fields such as `status` or `fulfillment_status`. The orders can
- also be paginated.
- x-authenticated: true
- parameters:
- - in: query
- name: q
- description: >-
- term to search orders' display ID, email, shipping address's first name,
- customer's first name, customer's last name, and customer's phone
- number.
- schema:
- type: string
- - in: query
- name: id
- description: Filter by ID.
- schema:
- type: string
- - in: query
- name: status
- style: form
- explode: false
- description: Filter by status.
- schema:
- type: array
- items:
- type: string
- enum:
- - pending
- - completed
- - archived
- - canceled
- - requires_action
- - in: query
- name: fulfillment_status
- style: form
- explode: false
- description: Fulfillment status to search for.
- schema:
- type: array
- items:
- type: string
- enum:
- - not_fulfilled
- - partially_fulfilled
- - fulfilled
- - partially_shipped
- - shipped
- - partially_returned
- - returned
- - canceled
- - requires_action
- - in: query
- name: payment_status
- style: form
- explode: false
- description: Payment status to search for.
- schema:
- type: array
- items:
- type: string
- enum:
- - not_paid
- - awaiting
- - captured
- - partially_refunded
- - refunded
- - canceled
- - requires_action
- - in: query
- name: display_id
- description: Filter by display ID.
- schema:
- type: string
- - in: query
- name: cart_id
- description: Filter by cart ID.
- schema:
- type: string
- - in: query
- name: email
- description: Filter by email.
- schema:
- type: string
- - in: query
- name: region_id
- description: Filter by region ID.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: Filter by the 3 character ISO currency code of the order.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- - in: query
- name: tax_rate
- description: Filter by tax rate.
- schema:
- type: string
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: canceled_at
- description: Filter by a cancelation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: limit
- description: Limit the number of orders returned.
- schema:
- type: integer
- default: 10
- - in: query
- name: offset
- description: The number of orders to skip when retrieving the orders.
- schema:
- type: integer
- default: 0
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- orders.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned orders.
- schema:
- type: string
- x-codegen:
- method: listOrders
- queryParams: StoreGetCustomersCustomerOrdersParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_me_orders/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_customers_me_orders/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_customers_me_orders/get.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Customers
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersListOrdersRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_payment-methods.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_payment-methods.yaml
deleted file mode 100644
index 67e16318a8..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_customers_me_payment-methods.yaml
+++ /dev/null
@@ -1,46 +0,0 @@
-get:
- operationId: GetCustomersCustomerPaymentMethods
- summary: Get Saved Payment Methods
- description: >-
- Retrieve the logged-in customer's saved payment methods. This API Route only
- works with payment providers created with the deprecated Payment Service
- interface. The payment methods are saved using the Payment Service's
- third-party service, and not on the Medusa backend. So, they're retrieved
- from the third-party service.
- x-authenticated: true
- deprecated: true
- x-codegen:
- method: listPaymentMethods
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_me_payment-methods/get.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_customers_me_payment-methods/get.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Customers
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersListPaymentMethodsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_password-reset.yaml b/www/apps/api-reference/specs/store/paths/store_customers_password-reset.yaml
deleted file mode 100644
index 5961ccda45..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_customers_password-reset.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-post:
- operationId: PostCustomersResetPassword
- summary: Reset Password
- description: >-
- Reset a Customer's password using a password token created by a previous
- request to the Request Password Reset API Route. If the password token
- expired, you must create a new one.
- externalDocs:
- description: How to reset password
- url: >-
- https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles#reset-password
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCustomersResetPasswordReq.yaml
- x-codegen:
- method: resetPassword
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_password-reset/post.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_customers_password-reset/post.sh
- tags:
- - Customers
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCustomersResetPasswordRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_customers_password-token.yaml b/www/apps/api-reference/specs/store/paths/store_customers_password-token.yaml
deleted file mode 100644
index 21ae415b8e..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_customers_password-token.yaml
+++ /dev/null
@@ -1,47 +0,0 @@
-post:
- operationId: PostCustomersCustomerPasswordToken
- summary: Request Password Reset
- description: >-
- Create a reset password token to be used in a subsequent Reset Password API
- Route. This emits the event `customer.password_reset`. If a notification
- provider is installed in the Medusa backend and is configured to handle this
- event, a notification to the customer, such as an email, may be sent with
- reset instructions.
- externalDocs:
- description: How to reset password
- url: >-
- https://docs.medusajs.com/modules/customers/storefront/implement-customer-profiles#reset-password
- requestBody:
- content:
- application/json:
- schema:
- $ref: >-
- ../components/schemas/StorePostCustomersCustomerPasswordTokenReq.yaml
- x-codegen:
- method: generatePasswordToken
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_customers_password-token/post.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_customers_password-token/post.sh
- tags:
- - Customers
- responses:
- '204':
- description: OK
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml b/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml
deleted file mode 100644
index bac81d521a..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_gift-cards_{code}.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-get:
- operationId: GetGiftCardsCode
- summary: Get Gift Card by Code
- description: Retrieve a Gift Card's details by its associated unique code.
- parameters:
- - in: path
- name: code
- required: true
- description: The unique Gift Card code.
- schema:
- type: string
- x-codegen:
- method: retrieve
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_gift-cards_{code}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_gift-cards_{code}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_gift-cards_{code}/get.sh
- tags:
- - Gift Cards
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreGiftCardsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml
deleted file mode 100644
index 42f6ca79d8..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}.yaml
+++ /dev/null
@@ -1,47 +0,0 @@
-get:
- operationId: GetOrderEditsOrderEdit
- summary: Retrieve an Order Edit
- description: Retrieve an Order Edit's details.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the OrderEdit.
- schema:
- type: string
- x-codegen:
- method: retrieve
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_order-edits_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_order-edits_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_order-edits_{id}/get.sh
- tags:
- - Order Edits
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreOrderEditsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml
deleted file mode 100644
index fb014d017c..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_complete.yaml
+++ /dev/null
@@ -1,49 +0,0 @@
-post:
- operationId: PostOrderEditsOrderEditComplete
- summary: Complete an Order Edit
- description: >-
- Complete an Order Edit and reflect its changes on the original order. Any
- additional payment required must be authorized first using the Payment
- Collection API Routes.
- externalDocs:
- description: How to handle order edits in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/handle-order-edits
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Order Edit.
- schema:
- type: string
- x-codegen:
- method: complete
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_order-edits_{id}_complete/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_order-edits_{id}_complete/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_order-edits_{id}_complete/post.sh
- tags:
- - Order Edits
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreOrderEditsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml b/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml
deleted file mode 100644
index 77758822dc..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_order-edits_{id}_decline.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-post:
- operationId: PostOrderEditsOrderEditDecline
- summary: Decline an Order Edit
- description: Decline an Order Edit. The changes are not reflected on the original order.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the OrderEdit.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostOrderEditsOrderEditDecline.yaml
- x-codegen:
- method: decline
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_order-edits_{id}_decline/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_order-edits_{id}_decline/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_order-edits_{id}_decline/post.sh
- tags:
- - Order Edits
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreOrderEditsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml
deleted file mode 100644
index ac43935045..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_orders.yaml
+++ /dev/null
@@ -1,78 +0,0 @@
-get:
- operationId: GetOrders
- summary: Look Up an Order
- description: >-
- Look up an order using filters. If the filters don't narrow down the results
- to a single order, a 404 response is returned with no orders.
- parameters:
- - in: query
- name: display_id
- required: true
- description: Filter by ID.
- schema:
- type: number
- - in: query
- name: fields
- description: Comma-separated fields that should be expanded in the returned order.
- schema:
- type: string
- - in: query
- name: expand
- description: Comma-separated relations that should be expanded in the returned order.
- schema:
- type: string
- - in: query
- name: email
- style: form
- explode: false
- description: Filter by email.
- required: true
- schema:
- type: string
- format: email
- - in: query
- name: shipping_address
- style: form
- explode: false
- description: Filter by the shipping address's postal code.
- schema:
- type: object
- properties:
- postal_code:
- type: string
- description: The postal code of the shipping address
- x-codegen:
- method: lookupOrder
- queryParams: StoreGetOrdersParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_orders/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_orders/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_orders/get.sh
- tags:
- - Orders
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreOrdersRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml b/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml
deleted file mode 100644
index 93e26c1aa0..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_orders_batch_customer_token.yaml
+++ /dev/null
@@ -1,56 +0,0 @@
-post:
- operationId: PostOrdersCustomerOrderClaim
- summary: Claim Order
- description: >-
- Allow the logged-in customer to claim ownership of one or more orders. This
- generates a token that can be used later on to verify the claim using the
- Verify Order Claim API Route. This also emits the event
- `order-update-token.created`. So, if you have a notification provider
- installed that handles this event and sends the customer a notification,
- such as an email, the customer should receive instructions on how to
- finalize their claim ownership.
- externalDocs:
- description: How to implement claim-order flow in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/implement-claim-order
- x-authenticated: true
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCustomersCustomerOrderClaimReq.yaml
- x-codegen:
- method: requestCustomerOrders
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_orders_batch_customer_token/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_orders_batch_customer_token/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_orders_batch_customer_token/post.sh
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Orders
- responses:
- '200':
- description: OK
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml
deleted file mode 100644
index 9adc1e3528..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_orders_cart_{cart_id}.yaml
+++ /dev/null
@@ -1,47 +0,0 @@
-get:
- operationId: GetOrdersOrderCartId
- summary: Get by Cart ID
- description: >-
- Retrieve an Order's details by the ID of the Cart that was used to create
- the Order.
- parameters:
- - in: path
- name: cart_id
- required: true
- description: The ID of Cart.
- schema:
- type: string
- x-codegen:
- method: retrieveByCartId
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_orders_cart_{cart_id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_orders_cart_{cart_id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_orders_cart_{cart_id}/get.sh
- tags:
- - Orders
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreOrdersRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml b/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml
deleted file mode 100644
index c6eda5bd8a..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_orders_customer_confirm.yaml
+++ /dev/null
@@ -1,50 +0,0 @@
-post:
- operationId: PostOrdersCustomerOrderClaimsCustomerOrderClaimAccept
- summary: Verify Order Claim
- description: >-
- Verify the claim order token provided to the customer when they request
- ownership of an order.
- externalDocs:
- description: How to implement claim-order flow in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/implement-claim-order
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostCustomersCustomerAcceptClaimReq.yaml
- x-codegen:
- method: confirmRequest
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_orders_customer_confirm/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_orders_customer_confirm/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_orders_customer_confirm/post.sh
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Orders
- responses:
- '200':
- description: OK
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
deleted file mode 100644
index b79018cb51..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml
+++ /dev/null
@@ -1,55 +0,0 @@
-get:
- operationId: GetOrdersOrder
- summary: Get an Order
- description: Retrieve an Order's details.
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Order.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be expanded in the returned order.
- schema:
- type: string
- - in: query
- name: expand
- description: Comma-separated relations that should be included in the returned order.
- schema:
- type: string
- x-codegen:
- method: retrieve
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_orders_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_orders_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_orders_{id}/get.sh
- tags:
- - Orders
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreOrdersRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml
deleted file mode 100644
index 7c117d86c9..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}.yaml
+++ /dev/null
@@ -1,66 +0,0 @@
-get:
- operationId: GetPaymentCollectionsPaymentCollection
- summary: Get a PaymentCollection
- description: Retrieve a Payment Collection's details.
- x-authenticated: false
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the PaymentCollection.
- schema:
- type: string
- - in: query
- name: fields
- description: >-
- Comma-separated fields that should be expanded in the returned payment
- collection.
- schema:
- type: string
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- payment collection.
- schema:
- type: string
- x-codegen:
- method: retrieve
- queryParams: StoreGetPaymentCollectionsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_payment-collections_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_payment-collections_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_payment-collections_{id}/get.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Payment Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs-v2/store/paths/store_payment-collections_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/paths/store_payment-collections_{id}_payment-sessions.yaml
rename to www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml
deleted file mode 100644
index 9bcb2e1e8a..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions.yaml
+++ /dev/null
@@ -1,57 +0,0 @@
-post:
- operationId: PostPaymentCollectionsSessions
- summary: Create a Payment Session
- description: Create a Payment Session for a payment provider in a Payment Collection.
- x-authenticated: false
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Payment Collection.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionSessionsReq.yaml
- x-codegen:
- method: managePaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_payment-collections_{id}_sessions/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_payment-collections_{id}_sessions/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_payment-collections_{id}_sessions/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Payment Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml
deleted file mode 100644
index e8896b1bc9..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch.yaml
+++ /dev/null
@@ -1,63 +0,0 @@
-post:
- operationId: PostPaymentCollectionsPaymentCollectionSessionsBatch
- summary: Manage Payment Sessions
- description: >-
- Create, update, or delete a list of payment sessions of a Payment
- Collections. If a payment session is not provided in the `sessions` array,
- it's deleted.
- x-authenticated: false
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Payment Collection.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: >-
- ../components/schemas/StorePostPaymentCollectionsBatchSessionsReq.yaml
- x-codegen:
- method: managePaymentSessionsBatch
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_payment-collections_{id}_sessions_batch/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_payment-collections_{id}_sessions_batch/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Payment Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml
deleted file mode 100644
index 028af4b2ed..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_batch_authorize.yaml
+++ /dev/null
@@ -1,60 +0,0 @@
-post:
- operationId: PostPaymentCollectionsSessionsBatchAuthorize
- summary: Authorize Payment Sessions
- description: Authorize the Payment Sessions of a Payment Collection.
- x-authenticated: false
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Payment Collections.
- schema:
- type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: >-
- ../components/schemas/StorePostPaymentCollectionsBatchSessionsAuthorizeReq.yaml
- x-codegen:
- method: authorizePaymentSessionsBatch
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_batch_authorize/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_payment-collections_{id}_sessions_batch_authorize/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_payment-collections_{id}_sessions_batch_authorize/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Payment Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml
deleted file mode 100644
index 35e1714798..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}.yaml
+++ /dev/null
@@ -1,60 +0,0 @@
-post:
- operationId: PostPaymentCollectionsPaymentCollectionPaymentSessionsSession
- summary: Refresh a Payment Session
- description: >-
- Refresh a Payment Session's data to ensure that it is in sync with the
- Payment Collection.
- x-authenticated: false
- parameters:
- - in: path
- name: id
- required: true
- description: The id of the PaymentCollection.
- schema:
- type: string
- - in: path
- name: session_id
- required: true
- description: The id of the Payment Session to be refreshed.
- schema:
- type: string
- x-codegen:
- method: refreshPaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Payment Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionsSessionRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml
deleted file mode 100644
index f55c6942e3..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_sessions_{session_id}_authorize.yaml
+++ /dev/null
@@ -1,60 +0,0 @@
-post:
- operationId: PostPaymentCollectionsSessionsSessionAuthorize
- summary: Authorize Payment Session
- description: Authorize a Payment Session of a Payment Collection.
- x-authenticated: false
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Payment Collection.
- schema:
- type: string
- - in: path
- name: session_id
- required: true
- description: The ID of the Payment Session.
- schema:
- type: string
- x-codegen:
- method: authorizePaymentSession
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: >-
- ../code_samples/JavaScript/store_payment-collections_{id}_sessions_{session_id}_authorize/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: >-
- ../code_samples/tsx/store_payment-collections_{id}_sessions_{session_id}_authorize/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: >-
- ../code_samples/Shell/store_payment-collections_{id}_sessions_{session_id}_authorize/post.sh
- security:
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Payment Collections
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePaymentCollectionsSessionRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories.yaml
deleted file mode 100644
index db7fe719f7..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_product-categories.yaml
+++ /dev/null
@@ -1,105 +0,0 @@
-get:
- operationId: GetProductCategories
- summary: List Product Categories
- description: >-
- Retrieve a list of product categories. The product categories can be
- filtered by fields such as `handle` or `q`. The product categories can also
- be paginated. This API Route can also be used to retrieve a product category
- by its handle.
- x-featureFlag: product_categories
- externalDocs:
- description: How to retrieve a product category by its handle
- url: >-
- https://docs.medusajs.com/modules/products/storefront/use-categories#get-a-category-by-its-handle
- parameters:
- - in: query
- name: q
- description: term used to search product category's names and handles.
- schema:
- type: string
- - in: query
- name: handle
- description: Filter by handle.
- schema:
- type: string
- - in: query
- name: parent_category_id
- description: >-
- Filter by the ID of a parent category. Only children of the provided
- parent category are retrieved.
- schema:
- type: string
- - in: query
- name: include_descendants_tree
- description: Whether all nested categories inside a category should be retrieved.
- schema:
- type: boolean
- - in: query
- name: offset
- description: >-
- The number of product categories to skip when retrieving the product
- categories.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of product categories returned.
- schema:
- type: integer
- default: 100
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- product categories.
- schema:
- type: string
- - in: query
- name: fields
- description: >-
- Comma-separated fields that should be included in the returned product
- categories.
- schema:
- type: string
- x-codegen:
- method: list
- queryParams: StoreGetProductCategoriesParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_product-categories/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_product-categories/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_product-categories/get.sh
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Product Categories
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreGetProductCategoriesRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
deleted file mode 100644
index 97b4ef6609..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml
+++ /dev/null
@@ -1,67 +0,0 @@
-get:
- operationId: GetProductCategoriesCategory
- summary: Get a Product Category
- description: Retrieve a Product Category's details.
- x-featureFlag: product_categories
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Product Category
- schema:
- type: string
- - in: query
- name: fields
- description: >-
- Comma-separated fields that should be expanded in the returned product
- category.
- schema:
- type: string
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- product category.
- schema:
- type: string
- x-codegen:
- method: retrieve
- queryParams: StoreGetProductCategoriesCategoryParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_product-categories_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_product-categories_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_product-categories_{id}/get.sh
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Product Categories
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreGetProductCategoriesCategoryRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml b/www/apps/api-reference/specs/store/paths/store_product-tags.yaml
deleted file mode 100644
index 64981bfa3b..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_product-tags.yaml
+++ /dev/null
@@ -1,136 +0,0 @@
-get:
- operationId: GetProductTags
- summary: List Product Tags
- description: >-
- Retrieve a list of product tags. The product tags can be filtered by fields
- such as `id` or `q`. The product tags can also be sorted or paginated.
- x-authenticated: true
- x-codegen:
- method: list
- queryParams: StoreGetProductTagsParams
- parameters:
- - in: query
- name: limit
- description: Limit the number of product tags returned.
- schema:
- type: integer
- default: 20
- - in: query
- name: offset
- description: The number of product tags to skip when retrieving the product tags.
- schema:
- type: integer
- default: 0
- - in: query
- name: order
- description: A product-tag field to sort-order the retrieved product tags by.
- schema:
- type: string
- - in: query
- name: discount_condition_id
- description: >-
- Filter by the ID of a discount condition. When provided, only tags that
- the discount condition applies for will be retrieved.
- schema:
- type: string
- - in: query
- name: value
- style: form
- explode: false
- description: Filter by tag values.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by IDs.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: q
- description: term to search product tag's value.
- schema:
- type: string
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_product-tags/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_product-tags/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_product-tags/get.sh
- tags:
- - Product Tags
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreProductTagsListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_product-types.yaml b/www/apps/api-reference/specs/store/paths/store_product-types.yaml
deleted file mode 100644
index 116d462d60..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_product-types.yaml
+++ /dev/null
@@ -1,141 +0,0 @@
-get:
- operationId: GetProductTypes
- summary: List Product Types
- description: >-
- Retrieve a list of product types. The product types can be filtered by
- fields such as `value` or `q`. The product types can also be sorted or
- paginated.
- x-authenticated: true
- parameters:
- - in: query
- name: limit
- description: Limit the number of product types returned.
- schema:
- type: integer
- default: 20
- - in: query
- name: offset
- description: The number of product types to skip when retrieving the product types.
- schema:
- type: integer
- default: 0
- - in: query
- name: order
- description: A product-type field to sort-order the retrieved product types by.
- schema:
- type: string
- - in: query
- name: discount_condition_id
- description: >-
- Filter by the ID of a discount condition. When provided, only types that
- the discount condition applies for will be retrieved.
- schema:
- type: string
- - in: query
- name: value
- style: form
- explode: false
- description: Filter by type values.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by IDs.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: q
- description: term to search product type's value.
- schema:
- type: string
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- x-codegen:
- method: list
- queryParams: StoreGetProductTypesParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_product-types/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_product-types/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_product-types/get.sh
- security:
- - api_token: []
- - cookie_auth: []
- - jwt_token: []
- tags:
- - Product Types
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreProductTypesListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '401':
- $ref: ../components/responses/unauthorized.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_products.yaml b/www/apps/api-reference/specs/store/paths/store_products.yaml
deleted file mode 100644
index 4ba195f147..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_products.yaml
+++ /dev/null
@@ -1,266 +0,0 @@
-get:
- operationId: GetProducts
- summary: List Products
- description: >
- Retrieves a list of products. The products can be filtered by fields such as
- `id` or `q`. The products can also be sorted or paginated.
-
- This API Route can also be used to retrieve a product by its handle.
-
-
- For accurate and correct pricing of the products based on the customer's
- context, it's highly recommended to pass fields such as
-
- `region_id`, `currency_code`, and `cart_id` when available.
-
-
- Passing `sales_channel_id` ensures retrieving only products available in the
- specified sales channel.
-
- You can alternatively use a publishable API key in the request header
- instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to retrieve a product by its handle
- url: >-
- https://docs.medusajs.com/modules/products/storefront/show-products#retrieve-product-by-handle
- parameters:
- - in: query
- name: q
- description: >-
- term used to search products' title, description, variant's title,
- variant's sku, and collection's title.
- schema:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: Filter by IDs.
- schema:
- oneOf:
- - type: string
- - type: array
- items:
- type: string
- - in: query
- name: sales_channel_id
- style: form
- explode: false
- description: >-
- Filter by sales channel IDs. When provided, only products available in
- the selected sales channels are retrieved. Alternatively, you can pass a
- publishable API key in the request header and this will have the same
- effect.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: collection_id
- style: form
- explode: false
- description: >-
- Filter by product collection IDs. When provided, only products that
- belong to the specified product collections are retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: type_id
- style: form
- explode: false
- description: >-
- Filter by product type IDs. When provided, only products that belong to
- the specified product types are retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: tags
- style: form
- explode: false
- description: >-
- Filter by product tag IDs. When provided, only products that belong to
- the specified product tags are retrieved.
- schema:
- type: array
- items:
- type: string
- - in: query
- name: title
- description: Filter by title.
- schema:
- type: string
- - in: query
- name: description
- description: Filter by description
- schema:
- type: string
- - in: query
- name: handle
- description: Filter by handle.
- schema:
- type: string
- - in: query
- name: is_giftcard
- description: Whether to retrieve regular products or gift-card products.
- schema:
- type: boolean
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: category_id
- style: form
- explode: false
- description: >-
- Filter by product category IDs. When provided, only products that belong
- to the specified product categories are retrieved.
- schema:
- type: array
- x-featureFlag: product_categories
- items:
- type: string
- - in: query
- name: include_category_children
- style: form
- explode: false
- description: >-
- Whether to include child product categories when filtering using the
- `category_id` field.
- schema:
- type: boolean
- x-featureFlag: product_categories
- - in: query
- name: offset
- description: The number of products to skip when retrieving the products.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of products returned.
- schema:
- type: integer
- default: 100
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- products.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned products.
- schema:
- type: string
- - in: query
- name: order
- description: A product field to sort-order the retrieved products by.
- schema:
- type: string
- - in: query
- name: cart_id
- description: >-
- The ID of the cart. This is useful for accurate pricing based on the
- cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: >-
- The ID of the region. This is useful for accurate pricing based on the
- selected region.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: >-
- A 3 character ISO currency code. This is useful for accurate pricing
- based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- x-codegen:
- method: list
- queryParams: StoreGetProductsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_products/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_products/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_products/get.sh
- tags:
- - Products
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreProductsListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_products_search.yaml b/www/apps/api-reference/specs/store/paths/store_products_search.yaml
deleted file mode 100644
index 06eeecdf7c..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_products_search.yaml
+++ /dev/null
@@ -1,42 +0,0 @@
-post:
- operationId: PostProductsSearch
- summary: Search Products
- description: >-
- Run a search query on products using the search service installed on the
- Medusa backend. The searching is handled through the search service, so the
- returned data's format depends on the search service you're using.
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostSearchReq.yaml
- x-codegen:
- method: search
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_products_search/post.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_products_search/post.sh
- tags:
- - Products
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostSearchRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
deleted file mode 100644
index d86103a15f..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml
+++ /dev/null
@@ -1,105 +0,0 @@
-get:
- operationId: GetProductsProduct
- summary: Get a Product
- description: >
- Retrieve a Product's details. For accurate and correct pricing of the
- product based on the customer's context, it's highly recommended to pass
- fields such as
-
- `region_id`, `currency_code`, and `cart_id` when available.
-
-
- Passing `sales_channel_id` ensures retrieving only products available in the
- current sales channel.
-
- You can alternatively use a publishable API key in the request header
- instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to pass product pricing parameters
- url: >-
- https://docs.medusajs.com/modules/products/storefront/show-products#product-pricing-parameters
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Product.
- schema:
- type: string
- - in: query
- name: sales_channel_id
- description: The ID of the sales channel the customer is viewing the product from.
- schema:
- type: string
- - in: query
- name: cart_id
- description: >-
- The ID of the cart. This is useful for accurate pricing based on the
- cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: >-
- The ID of the region. This is useful for accurate pricing based on the
- selected region.
- schema:
- type: string
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- product.
- schema:
- type: string
- - in: query
- name: fields
- description: Comma-separated fields that should be included in the returned product.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: >-
- A 3 character ISO currency code. This is useful for accurate pricing
- based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- x-codegen:
- method: retrieve
- queryParams: StoreGetProductsProductParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_products_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_products_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_products_{id}/get.sh
- tags:
- - Products
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreProductsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_regions.yaml b/www/apps/api-reference/specs/store/paths/store_regions.yaml
index bf97482e18..d360b3398d 100644
--- a/www/apps/api-reference/specs/store/paths/store_regions.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml
@@ -3,81 +3,10 @@ get:
summary: List Regions
description: >-
Retrieve a list of regions. The regions can be filtered by fields such as
- `created_at`. The regions can also be paginated. This API Route is useful to
- show the customer all available regions to choose from.
- externalDocs:
- description: How to use regions in a storefront
- url: >-
- https://docs.medusajs.com/modules/regions-and-currencies/storefront/use-regions
- parameters:
- - in: query
- name: offset
- description: The number of regions to skip when retrieving the regions.
- schema:
- type: integer
- default: 0
- - in: query
- name: limit
- description: Limit the number of regions returned.
- schema:
- type: integer
- default: 100
- - in: query
- name: created_at
- description: Filter by a creation date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- - in: query
- name: updated_at
- description: Filter by an update date range.
- schema:
- type: object
- properties:
- lt:
- type: string
- description: filter by dates less than this date
- format: date
- gt:
- type: string
- description: filter by dates greater than this date
- format: date
- lte:
- type: string
- description: filter by dates less than or equal to this date
- format: date
- gte:
- type: string
- description: filter by dates greater than or equal to this date
- format: date
- x-codegen:
- method: list
- queryParams: StoreGetRegionsParams
+ `id`. The regions can also be sorted or paginated.
+ x-authenticated: false
+ parameters: []
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_regions/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_regions/get.tsx
- lang: Shell
label: cURL
source:
@@ -85,14 +14,10 @@ get:
tags:
- Regions
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreRegionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -101,3 +26,7 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
index 67ad39ae69..8c726fd014 100644
--- a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml
@@ -1,25 +1,18 @@
get:
- operationId: GetRegionsRegion
+ operationId: GetRegionsId
summary: Get a Region
- description: Retrieve a Region's details.
+ description: >-
+ Retrieve a region by its ID. You can expand the region's relations or select
+ the fields that should be returned.
+ x-authenticated: false
parameters:
- - in: path
- name: id
+ - name: id
+ in: path
+ description: The region's ID.
required: true
- description: The ID of the Region.
schema:
type: string
- x-codegen:
- method: retrieve
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_regions_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_regions_{id}/get.tsx
- lang: Shell
label: cURL
source:
@@ -27,14 +20,10 @@ get:
tags:
- Regions
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreRegionsRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -43,3 +32,7 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs-v2/store/paths/store_regions_{id}_payment-providers.yaml b/www/apps/api-reference/specs/store/paths/store_regions_{id}_payment-providers.yaml
similarity index 100%
rename from www/apps/api-reference/specs-v2/store/paths/store_regions_{id}_payment-providers.yaml
rename to www/apps/api-reference/specs/store/paths/store_regions_{id}_payment-providers.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
deleted file mode 100644
index aa5801b6d4..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_return-reasons.yaml
+++ /dev/null
@@ -1,40 +0,0 @@
-get:
- operationId: GetReturnReasons
- summary: List Return Reasons
- description: >-
- Retrieve a list of Return Reasons. This is useful when implementing a Create
- Return flow in the storefront.
- x-codegen:
- method: list
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_return-reasons/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_return-reasons/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_return-reasons/get.sh
- tags:
- - Return Reasons
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreReturnReasonsListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
deleted file mode 100644
index fae3979347..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-get:
- operationId: GetReturnReasonsReason
- summary: Get a Return Reason
- description: Retrieve a Return Reason's details.
- parameters:
- - in: path
- name: id
- required: true
- description: The id of the Return Reason.
- schema:
- type: string
- x-codegen:
- method: retrieve
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_return-reasons_{id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_return-reasons_{id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_return-reasons_{id}/get.sh
- tags:
- - Return Reasons
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreReturnReasonsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_returns.yaml b/www/apps/api-reference/specs/store/paths/store_returns.yaml
deleted file mode 100644
index 7f8aca95a2..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_returns.yaml
+++ /dev/null
@@ -1,48 +0,0 @@
-post:
- operationId: PostReturns
- summary: Create Return
- description: >-
- Create a Return for an Order. If a return shipping method is specified, the
- return is automatically fulfilled.
- externalDocs:
- description: How to create a return in a storefront
- url: https://docs.medusajs.com/modules/orders/storefront/create-return
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostReturnsReq.yaml
- x-codegen:
- method: create
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_returns/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_returns/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_returns/post.sh
- tags:
- - Returns
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreReturnsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
deleted file mode 100644
index 502166c2cc..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-get:
- operationId: GetShippingOptions
- summary: Get Shipping Options
- description: Retrieve a list of Shipping Options.
- parameters:
- - in: query
- name: is_return
- description: >-
- Whether return shipping options should be included. By default, all
- shipping options are returned.
- schema:
- type: boolean
- - in: query
- name: product_ids
- description: >-
- "Comma-separated list of Product IDs to filter Shipping Options by. If
- provided, only shipping options that can be used with the provided
- products are retrieved."
- schema:
- type: string
- - in: query
- name: region_id
- description: >-
- "The ID of the region that the shipping options belong to. If not
- provided, all shipping options are retrieved."
- schema:
- type: string
- x-codegen:
- method: list
- queryParams: StoreGetShippingOptionsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_shipping-options/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_shipping-options/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_shipping-options/get.sh
- tags:
- - Shipping Options
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreShippingOptionsListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml
index ad69d42ff2..6d78928e6f 100644
--- a/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml
+++ b/www/apps/api-reference/specs/store/paths/store_shipping-options_{cart_id}.yaml
@@ -1,29 +1,18 @@
get:
- operationId: GetShippingOptionsCartId
- summary: List for Cart
- description: Retrieve a list of Shipping Options available for a cart.
- externalDocs:
- description: How to implement shipping step in checkout
- url: >-
- https://docs.medusajs.com/modules/carts-and-checkout/storefront/implement-checkout-flow#shipping-step
+ operationId: GetShippingOptionsCart_id
+ summary: Get a Shipping Option
+ description: >-
+ Retrieve a shipping option by its ID. You can expand the shipping option's
+ relations or select the fields that should be returned.
+ x-authenticated: false
parameters:
- - in: path
- name: cart_id
+ - name: cart_id
+ in: path
+ description: The shipping option's cart id.
required: true
- description: The ID of the Cart.
schema:
type: string
- x-codegen:
- method: listCartOptions
x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_shipping-options_{cart_id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_shipping-options_{cart_id}/get.tsx
- lang: Shell
label: cURL
source:
@@ -31,14 +20,10 @@ get:
tags:
- Shipping Options
responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreCartShippingOptionsListRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
+ '401':
+ $ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
@@ -47,3 +32,7 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
+ requestBody:
+ content:
+ application/json:
+ schema: {}
diff --git a/www/apps/api-reference/specs/store/paths/store_swaps.yaml b/www/apps/api-reference/specs/store/paths/store_swaps.yaml
deleted file mode 100644
index b069f049f5..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_swaps.yaml
+++ /dev/null
@@ -1,62 +0,0 @@
-post:
- operationId: PostSwaps
- summary: Create a Swap
- description: >
- Create a Swap for an Order. This will also create a return and associate it
- with the swap. If a return shipping option is specified, the return will
- automatically be fulfilled.
-
- To complete the swap, you must use the Complete Cart API Route passing it
- the ID of the swap's cart.
-
-
- An idempotency key will be generated if none is provided in the header
- `Idempotency-Key` and added to
-
- the response. If an error occurs during swap creation or the request is
- interrupted for any reason, the swap creation can be retried by passing the
- idempotency
-
- key in the `Idempotency-Key` header.
- externalDocs:
- description: How to create a swap
- url: https://docs.medusajs.com/modules/orders/storefront/create-swap
- requestBody:
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StorePostSwapsReq.yaml
- x-codegen:
- method: create
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_swaps/post.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_swaps/post.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_swaps/post.sh
- tags:
- - Swaps
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreSwapsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml b/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml
deleted file mode 100644
index a0054ac2b5..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_swaps_{cart_id}.yaml
+++ /dev/null
@@ -1,45 +0,0 @@
-get:
- operationId: GetSwapsSwapCartId
- summary: Get by Cart ID
- description: Retrieve a Swap's details by the ID of its cart.
- parameters:
- - in: path
- name: cart_id
- required: true
- description: The id of the Cart
- schema:
- type: string
- x-codegen:
- method: retrieveByCartId
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_swaps_{cart_id}/get.js
- - lang: tsx
- label: Medusa React
- source:
- $ref: ../code_samples/tsx/store_swaps_{cart_id}/get.tsx
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_swaps_{cart_id}/get.sh
- tags:
- - Swaps
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreSwapsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_variants.yaml b/www/apps/api-reference/specs/store/paths/store_variants.yaml
deleted file mode 100644
index 472bc9eb9c..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_variants.yaml
+++ /dev/null
@@ -1,176 +0,0 @@
-get:
- operationId: GetVariants
- summary: Get Product Variants
- description: >
- Retrieves a list of product variants. The product variants can be filtered
- by fields such as `id` or `title`. The product variants can also be
- paginated.
-
-
- For accurate and correct pricing of the product variants based on the
- customer's context, it's highly recommended to pass fields such as
-
- `region_id`, `currency_code`, and `cart_id` when available.
-
-
- Passing `sales_channel_id` ensures retrieving only variants of products
- available in the specified sales channel.
-
- You can alternatively use a publishable API key in the request header
- instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to pass product pricing parameters
- url: >-
- https://docs.medusajs.com/modules/products/storefront/show-products#product-pricing-parameters
- parameters:
- - in: query
- name: ids
- description: >-
- Filter by a comma-separated list of IDs. If supplied, it overrides the
- `id` parameter.
- schema:
- type: string
- - in: query
- name: id
- style: form
- explode: false
- description: >-
- Filter by one or more IDs. If `ids` is supplied, it's overrides the
- value of this parameter.
- schema:
- oneOf:
- - type: string
- description: Filter by an ID.
- - type: array
- description: Filter by IDs.
- items:
- type: string
- - in: query
- name: sales_channel_id
- description: >-
- "Filter by sales channel IDs. When provided, only products available in
- the selected sales channels are retrieved. Alternatively, you can pass a
- publishable API key in the request header and this will have the same
- effect."
- schema:
- type: string
- - in: query
- name: expand
- description: >-
- Comma-separated relations that should be expanded in the returned
- product variants.
- schema:
- type: string
- - in: query
- name: fields
- description: >-
- Comma-separated fields that should be included in the returned product
- variants.
- schema:
- type: string
- - in: query
- name: offset
- description: The number of products to skip when retrieving the product variants.
- schema:
- type: number
- default: '0'
- - in: query
- name: limit
- description: Limit the number of product variants returned.
- schema:
- type: number
- default: '100'
- - in: query
- name: cart_id
- description: >-
- The ID of the cart. This is useful for accurate pricing based on the
- cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: >-
- The ID of the region. This is useful for accurate pricing based on the
- selected region.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: >-
- A 3 character ISO currency code. This is useful for accurate pricing
- based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- - in: query
- name: title
- style: form
- explode: false
- description: Filter by title
- schema:
- oneOf:
- - type: string
- description: a single title to filter by
- - type: array
- description: multiple titles to filter by
- items:
- type: string
- - in: query
- name: inventory_quantity
- description: Filter by available inventory quantity
- schema:
- oneOf:
- - type: number
- description: A specific number to filter by.
- - type: object
- description: Filter using less and greater than comparisons.
- properties:
- lt:
- type: number
- description: Filter by inventory quantity less than this number
- gt:
- type: number
- description: Filter by inventory quantity greater than this number
- lte:
- type: number
- description: Filter by inventory quantity less than or equal to this number
- gte:
- type: number
- description: >-
- Filter by inventory quantity greater than or equal to this
- number
- x-codegen:
- method: list
- queryParams: StoreGetVariantsParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_variants/get.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_variants/get.sh
- tags:
- - Product Variants
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreVariantsListRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml
deleted file mode 100644
index d46d5ef79b..0000000000
--- a/www/apps/api-reference/specs/store/paths/store_variants_{id}.yaml
+++ /dev/null
@@ -1,91 +0,0 @@
-get:
- operationId: GetVariantsVariant
- summary: Get a Product Variant
- description: >
- Retrieve a Product Variant's details. For accurate and correct pricing of
- the product variant based on the customer's context, it's highly recommended
- to pass fields such as
-
- `region_id`, `currency_code`, and `cart_id` when available.
-
-
- Passing `sales_channel_id` ensures retrieving only variants of products
- available in the current sales channel.
-
- You can alternatively use a publishable API key in the request header
- instead of passing a `sales_channel_id`.
- externalDocs:
- description: How to pass product pricing parameters
- url: >-
- https://docs.medusajs.com/modules/products/storefront/show-products#product-pricing-parameters
- parameters:
- - in: path
- name: id
- required: true
- description: The ID of the Product Variant.
- schema:
- type: string
- - in: query
- name: sales_channel_id
- description: >-
- The ID of the sales channel the customer is viewing the product variant
- from.
- schema:
- type: string
- - in: query
- name: cart_id
- description: >-
- The ID of the cart. This is useful for accurate pricing based on the
- cart's context.
- schema:
- type: string
- - in: query
- name: region_id
- description: >-
- The ID of the region. This is useful for accurate pricing based on the
- selected region.
- schema:
- type: string
- - in: query
- name: currency_code
- style: form
- explode: false
- description: >-
- A 3 character ISO currency code. This is useful for accurate pricing
- based on the selected currency.
- schema:
- type: string
- externalDocs:
- url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
- description: See a list of codes.
- x-codegen:
- method: retrieve
- queryParams: StoreGetVariantsVariantParams
- x-codeSamples:
- - lang: JavaScript
- label: JS Client
- source:
- $ref: ../code_samples/JavaScript/store_variants_{id}/get.js
- - lang: Shell
- label: cURL
- source:
- $ref: ../code_samples/Shell/store_variants_{id}/get.sh
- tags:
- - Product Variants
- responses:
- '200':
- description: OK
- content:
- application/json:
- schema:
- $ref: ../components/schemas/StoreVariantsRes.yaml
- '400':
- $ref: ../components/responses/400_error.yaml
- '404':
- $ref: ../components/responses/not_found_error.yaml
- '409':
- $ref: ../components/responses/invalid_state_error.yaml
- '422':
- $ref: ../components/responses/invalid_request_error.yaml
- '500':
- $ref: ../components/responses/500_error.yaml
diff --git a/www/apps/api-reference/types/openapi.ts b/www/apps/api-reference/types/openapi.ts
index a6e5d3d31c..4487edad62 100644
--- a/www/apps/api-reference/types/openapi.ts
+++ b/www/apps/api-reference/types/openapi.ts
@@ -1,7 +1,6 @@
import type { OpenAPIV3 } from "openapi-types"
export type Area = "admin" | "store"
-export type Version = "1" | "2"
export type Code = {
lang: string
diff --git a/www/apps/api-reference/utils/base-path-url.ts b/www/apps/api-reference/utils/base-path-url.ts
new file mode 100644
index 0000000000..c9215b4c46
--- /dev/null
+++ b/www/apps/api-reference/utils/base-path-url.ts
@@ -0,0 +1,5 @@
+import { getLinkWithBasePath } from "docs-ui"
+
+export default function basePathUrl(path: string) {
+ return getLinkWithBasePath(path, process.env.NEXT_PUBLIC_BASE_PATH)
+}
diff --git a/www/apps/api-reference/utils/get-paths-of-tag.ts b/www/apps/api-reference/utils/get-paths-of-tag.ts
index 009c86bdd3..a2ce748c6a 100644
--- a/www/apps/api-reference/utils/get-paths-of-tag.ts
+++ b/www/apps/api-reference/utils/get-paths-of-tag.ts
@@ -1,7 +1,7 @@
import path from "path"
import { promises as fs } from "fs"
import type { OpenAPIV3 } from "openapi-types"
-import type { Operation, Document, Version } from "@/types/openapi"
+import type { Operation, Document } from "@/types/openapi"
import readSpecDocument from "./read-spec-document"
import getSectionId from "./get-section-id"
import OpenAPIParser from "@readme/openapi-parser"
@@ -12,15 +12,10 @@ type ParsedPathItemObject = OpenAPIV3.PathItemObject & {
export default async function getPathsOfTag(
tagName: string,
- area: string,
- version: Version = "1"
+ area: string
): Promise {
// get path files
- const basePath = path.join(
- process.cwd(),
- version === "1" ? "specs" : "specs-v2",
- `${area}/paths`
- )
+ const basePath = path.join(process.cwd(), "specs", `${area}/paths`)
const files = await fs.readdir(basePath)
diff --git a/www/apps/api-reference/utils/get-url.ts b/www/apps/api-reference/utils/get-url.ts
index 67297b198b..c4eeaec365 100644
--- a/www/apps/api-reference/utils/get-url.ts
+++ b/www/apps/api-reference/utils/get-url.ts
@@ -1,5 +1,6 @@
import { config } from "../config"
+import basePathUrl from "./base-path-url"
export default function getUrl(area: string, tagName?: string): string {
- return `${config.baseUrl}/api/${area}#${tagName}`
+ return `${config.baseUrl}${basePathUrl(`/api/${area}#${tagName}`)}`
}
diff --git a/www/apps/book/.env.sample b/www/apps/book/.env.sample
index 6cd0d41119..49f78d1ae0 100644
--- a/www/apps/book/.env.sample
+++ b/www/apps/book/.env.sample
@@ -9,6 +9,7 @@ NEXT_PUBLIC_RESOURCES_URL=
NEXT_PUBLIC_USER_GUIDE_URL=
NEXT_PUBLIC_UI_URL=
NEXT_PUBLIC_API_URL=
+NEXT_PUBLIC_DOCS_V1_URL=
ALGOLIA_WRITE_API_KEY=
ANALYZE_BUNDLE=
NEXT_PUBLIC_AI_ASSISTANT_URL=
diff --git a/www/apps/book/next.config.mjs b/www/apps/book/next.config.mjs
index 3b1df77911..b7f82a6899 100644
--- a/www/apps/book/next.config.mjs
+++ b/www/apps/book/next.config.mjs
@@ -45,7 +45,7 @@ const withMDX = mdx({
process.env.VERCEL_ENV !== "production"
? process.env.NEXT_PUBLIC_API_URL
: undefined,
- path: "api",
+ path: "v2/api",
},
},
},
@@ -91,6 +91,44 @@ const nextConfig = {
transpilePackages: ["docs-ui"],
basePath: process.env.NEXT_PUBLIC_BASE_PATH || "/v2",
+ async rewrites() {
+ return {
+ fallback: [
+ {
+ source: "/v2/resources",
+ destination: `${
+ process.env.NEXT_PUBLIC_RESOURCES_URL || "https://localhost:3001"
+ }/v2/resources`,
+ basePath: false,
+ },
+ {
+ source: "/v2/resources/:path*",
+ destination: `${
+ process.env.NEXT_PUBLIC_RESOURCES_URL || "https://localhost:3001"
+ }/v2/resources/:path*`,
+ basePath: false,
+ },
+ // TODO comment out once we have the user guide published
+ // {
+ // source: "/user-guide",
+ // destination: `${process.env.NEXT_PUBLIC_USER_GUIDE_URL}/user-guide`,
+ // basePath: false,
+ // },
+ // {
+ // source: "/user-guide/:path*",
+ // destination: `${process.env.NEXT_PUBLIC_USER_GUIDE_URL}/user-guide/:path*`,
+ // basePath: false,
+ // },
+ {
+ source: "/:path*",
+ destination: `${
+ process.env.NEXT_PUBLIC_DOCS_V1_URL || "https://localhost:3000"
+ }/:path*`,
+ basePath: false,
+ },
+ ],
+ }
+ },
}
export default withMDX(nextConfig)
diff --git a/www/apps/book/utils/base-path-url.ts b/www/apps/book/utils/base-path-url.ts
index b8b852feda..b8584730ad 100644
--- a/www/apps/book/utils/base-path-url.ts
+++ b/www/apps/book/utils/base-path-url.ts
@@ -1,3 +1,5 @@
+import { getLinkWithBasePath } from "docs-ui"
+
export function basePathUrl(path = "") {
- return `${process.env.NEXT_PUBLIC_BASE_PATH || ""}${path}`
+ return getLinkWithBasePath(path, process.env.NEXT_PUBLIC_BASE_PATH)
}
diff --git a/www/apps/resources/.env.sample b/www/apps/resources/.env.sample
index 87d2ab8df6..f81125850a 100644
--- a/www/apps/resources/.env.sample
+++ b/www/apps/resources/.env.sample
@@ -10,6 +10,7 @@ NEXT_PUBLIC_DOCS_URL=
NEXT_PUBLIC_USER_GUIDE_URL=
NEXT_PUBLIC_UI_URL=
NEXT_PUBLIC_API_URL=
+NEXT_PUBLIC_DOCS_V1_URL=
ALGOLIA_WRITE_API_KEY=
ANALYZE_BUNDLE=
NEXT_PUBLIC_AI_ASSISTANT_URL=
diff --git a/www/apps/resources/mdx-options.mjs b/www/apps/resources/mdx-options.mjs
index 7c721b6eaa..a972bc92c2 100644
--- a/www/apps/resources/mdx-options.mjs
+++ b/www/apps/resources/mdx-options.mjs
@@ -43,7 +43,7 @@ const mdxPluginOptions = {
process.env.VERCEL_ENV !== "production"
? process.env.NEXT_PUBLIC_API_URL
: undefined,
- path: "api",
+ path: "v2/api",
},
},
},
diff --git a/www/apps/resources/utils/base-path-url.ts b/www/apps/resources/utils/base-path-url.ts
index e10c6f9cbb..b8584730ad 100644
--- a/www/apps/resources/utils/base-path-url.ts
+++ b/www/apps/resources/utils/base-path-url.ts
@@ -1,3 +1,5 @@
+import { getLinkWithBasePath } from "docs-ui"
+
export function basePathUrl(path = "") {
- return `${process.env.NEXT_PUBLIC_BASE_PATH}${path}`
+ return getLinkWithBasePath(path, process.env.NEXT_PUBLIC_BASE_PATH)
}
diff --git a/www/apps/ui/src/lib/base-path-url.ts b/www/apps/ui/src/lib/base-path-url.ts
index b8b852feda..b8584730ad 100644
--- a/www/apps/ui/src/lib/base-path-url.ts
+++ b/www/apps/ui/src/lib/base-path-url.ts
@@ -1,3 +1,5 @@
+import { getLinkWithBasePath } from "docs-ui"
+
export function basePathUrl(path = "") {
- return `${process.env.NEXT_PUBLIC_BASE_PATH || ""}${path}`
+ return getLinkWithBasePath(path, process.env.NEXT_PUBLIC_BASE_PATH)
}
diff --git a/www/apps/user-guide/next.config.mjs b/www/apps/user-guide/next.config.mjs
index 9f3f60520c..bad202e3ae 100644
--- a/www/apps/user-guide/next.config.mjs
+++ b/www/apps/user-guide/next.config.mjs
@@ -46,7 +46,7 @@ const withMDX = mdx({
process.env.VERCEL_ENV !== "production"
? process.env.NEXT_PUBLIC_API_URL
: undefined,
- path: "api",
+ path: "v2/api",
},
},
},
diff --git a/www/apps/user-guide/utils/base-path-url.ts b/www/apps/user-guide/utils/base-path-url.ts
index e10c6f9cbb..b8584730ad 100644
--- a/www/apps/user-guide/utils/base-path-url.ts
+++ b/www/apps/user-guide/utils/base-path-url.ts
@@ -1,3 +1,5 @@
+import { getLinkWithBasePath } from "docs-ui"
+
export function basePathUrl(path = "") {
- return `${process.env.NEXT_PUBLIC_BASE_PATH}${path}`
+ return getLinkWithBasePath(path, process.env.NEXT_PUBLIC_BASE_PATH)
}
diff --git a/www/packages/docs-ui/package.json b/www/packages/docs-ui/package.json
index 1e372a25c4..dbacafea67 100644
--- a/www/packages/docs-ui/package.json
+++ b/www/packages/docs-ui/package.json
@@ -30,7 +30,8 @@
"build:js:cjs": "tsc --project tsconfig.cjs.json && tsc-alias -p tsconfig.cjs.json",
"build:js:esm": "tsc --project tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
"clean": "rimraf dist",
- "dev": "yarn build:js:cjs && yarn build:js:esm"
+ "dev": "yarn build:js:cjs && yarn build:js:esm",
+ "lint": "eslint src --fix"
},
"devDependencies": {
"@types/react": "^18.2.0",
@@ -38,6 +39,7 @@
"@types/react-google-recaptcha": "^2.1.6",
"clsx": "^2.0.0",
"cpy-cli": "^5.0.0",
+ "eslint": "^8",
"eslint-config-docs": "*",
"next": "14.1.0",
"react": "^18.2.0",
diff --git a/www/packages/docs-ui/src/components/Navbar/Link/index.tsx b/www/packages/docs-ui/src/components/Navbar/Link/index.tsx
index 44efccd873..fee3cc4fe0 100644
--- a/www/packages/docs-ui/src/components/Navbar/Link/index.tsx
+++ b/www/packages/docs-ui/src/components/Navbar/Link/index.tsx
@@ -18,7 +18,7 @@ export const NavbarLink = ({
label,
className,
isActive,
- badge
+ badge,
}: NavbarLinkProps) => {
return (
{label}
- {badge && }
+ {badge && (
+
+ )}
)
}
diff --git a/www/packages/docs-ui/src/components/Navbar/NavbarDivider/index.tsx b/www/packages/docs-ui/src/components/Navbar/NavbarDivider/index.tsx
index 4cd0fee2a8..933a83e273 100644
--- a/www/packages/docs-ui/src/components/Navbar/NavbarDivider/index.tsx
+++ b/www/packages/docs-ui/src/components/Navbar/NavbarDivider/index.tsx
@@ -3,9 +3,8 @@ import React from "react"
export const NavbarDivider = () => {
return (
-
+
)
-}
\ No newline at end of file
+}
diff --git a/www/packages/docs-ui/src/components/Navbar/index.tsx b/www/packages/docs-ui/src/components/Navbar/index.tsx
index 4ea2756fc9..09d76bbc39 100644
--- a/www/packages/docs-ui/src/components/Navbar/index.tsx
+++ b/www/packages/docs-ui/src/components/Navbar/index.tsx
@@ -8,13 +8,15 @@ import { NavbarSearchModalOpener } from "./SearchModalOpener"
import { NavbarMobileMenuButtonProps } from "./MobileMenu/Button"
import { NavbarDivider } from "./NavbarDivider"
-export type NavbarItem = {
- type: "link"
- props: NavbarLinkProps
-} | {
- type: "divider"
- props?: {}
-}
+export type NavbarItem =
+ | {
+ type: "link"
+ props: NavbarLinkProps
+ }
+ | {
+ type: "divider"
+ props?: Record
+ }
export type NavbarProps = {
logo: NavbarLogoProps
@@ -54,10 +56,10 @@ export const Navbar = ({
>