chore(docs): Generated API Reference (#3935)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
This commit is contained in:
co-authored by
olivermrbl
Shahed Nasser
parent
beffa3de0e
commit
cce2b3827e
+24
-17
@@ -15338,7 +15338,7 @@
|
||||
"/admin/products/{id}/options": {
|
||||
"post": {
|
||||
"operationId": "PostProductsProductOptions",
|
||||
"summary": "Add an Option",
|
||||
"summary": "Add a Product Option",
|
||||
"x-authenticated": true,
|
||||
"description": "Adds a Product Option to a Product",
|
||||
"parameters": [
|
||||
@@ -15543,7 +15543,7 @@
|
||||
{
|
||||
"lang": "JavaScript",
|
||||
"label": "JS Client",
|
||||
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.products.deleteOption(product_id, option_id)\n.then(({ option_id, object, delete, product }) => {\n console.log(product.id);\n});\n"
|
||||
"source": "import Medusa from \"@medusajs/medusa-js\"\nconst medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })\n// must be previously logged in or use api token\nmedusa.admin.products.deleteOption(product_id, option_id)\n.then(({ option_id, object, deleted, product }) => {\n console.log(product.id);\n});\n"
|
||||
},
|
||||
{
|
||||
"lang": "Shell",
|
||||
@@ -29085,9 +29085,6 @@
|
||||
},
|
||||
"AdminPostProductsProductVariantsVariantReq": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"prices"
|
||||
],
|
||||
"properties": {
|
||||
"title": {
|
||||
"description": "The title to identify the Product Variant by.",
|
||||
@@ -30836,6 +30833,9 @@
|
||||
"variants",
|
||||
"variants.options",
|
||||
"variants.prices"
|
||||
],
|
||||
"totals": [
|
||||
"variants.purchasable"
|
||||
]
|
||||
},
|
||||
"required": [
|
||||
@@ -31953,6 +31953,9 @@
|
||||
"options",
|
||||
"prices",
|
||||
"product"
|
||||
],
|
||||
"totals": [
|
||||
"purchasable"
|
||||
]
|
||||
},
|
||||
"required": [
|
||||
@@ -32389,7 +32392,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -32832,7 +32835,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
}
|
||||
@@ -33942,7 +33945,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -34160,7 +34163,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -34435,7 +34438,7 @@
|
||||
"description": "The unique randomly generated key used to determine the state of a process.",
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -35781,7 +35784,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -36260,7 +36263,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -36504,7 +36507,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -37673,6 +37676,10 @@
|
||||
"example": {
|
||||
"car": "white"
|
||||
}
|
||||
},
|
||||
"purchasable": {
|
||||
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -37877,7 +37884,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -38214,7 +38221,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -39512,7 +39519,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -39768,7 +39775,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
|
||||
+1
-1
@@ -2,6 +2,6 @@ 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.deleteOption(product_id, option_id)
|
||||
.then(({ option_id, object, delete, product }) => {
|
||||
.then(({ option_id, object, deleted, product }) => {
|
||||
console.log(product.id);
|
||||
});
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
type: object
|
||||
required:
|
||||
- prices
|
||||
properties:
|
||||
title:
|
||||
description: The title to identify the Product Variant by.
|
||||
|
||||
@@ -10,6 +10,8 @@ x-expanded-relations:
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
totals:
|
||||
- variants.purchasable
|
||||
required:
|
||||
- products
|
||||
- count
|
||||
|
||||
@@ -5,6 +5,8 @@ x-expanded-relations:
|
||||
- options
|
||||
- prices
|
||||
- product
|
||||
totals:
|
||||
- purchasable
|
||||
required:
|
||||
- variants
|
||||
- count
|
||||
|
||||
@@ -130,7 +130,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
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.
|
||||
|
||||
@@ -141,5 +141,5 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
title: Product with decorated variants
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: ./Product.yaml
|
||||
- type: object
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./DecoratedVariant.yaml
|
||||
@@ -1,9 +0,0 @@
|
||||
title: Decorated Product Variant
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: ./PricedVariant.yaml
|
||||
- type: object
|
||||
properties:
|
||||
purchasable:
|
||||
type: boolean
|
||||
description: Boolean indicating if variant is purchasable.
|
||||
@@ -71,7 +71,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -126,7 +126,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -26,7 +26,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: Date which the idempotency key was locked.
|
||||
|
||||
@@ -245,7 +245,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
external_id:
|
||||
description: The ID of an external order.
|
||||
|
||||
@@ -102,7 +102,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -82,7 +82,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
amount:
|
||||
description: The amount that the Payment Session has been authorized for.
|
||||
|
||||
@@ -189,3 +189,13 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
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
|
||||
|
||||
@@ -67,7 +67,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -103,7 +103,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
received_at:
|
||||
description: The date with timezone at which the return was received.
|
||||
|
||||
@@ -154,7 +154,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -44,7 +44,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
post:
|
||||
operationId: PostProductsProductOptions
|
||||
summary: Add an Option
|
||||
summary: Add a Product Option
|
||||
x-authenticated: true
|
||||
description: Adds a Product Option to a Product
|
||||
parameters:
|
||||
|
||||
+28
-12
@@ -6489,7 +6489,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -6932,7 +6932,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
}
|
||||
@@ -8042,7 +8042,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -8260,7 +8260,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -8535,7 +8535,7 @@
|
||||
"description": "The unique randomly generated key used to determine the state of a process.",
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -9881,7 +9881,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -10360,7 +10360,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -10604,7 +10604,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -11773,6 +11773,10 @@
|
||||
"example": {
|
||||
"car": "white"
|
||||
}
|
||||
},
|
||||
"purchasable": {
|
||||
"description": "Only used with the inventory modules.\nA boolean value indicating whether the Product Variant is purchasable.\nA variant is purchasable if:\n - inventory is not managed\n - it has no inventory items\n - it is in stock\n - it is backorderable.\n",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -11977,7 +11981,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -12296,7 +12300,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -14753,6 +14757,9 @@
|
||||
"variants",
|
||||
"variants.options",
|
||||
"variants.prices"
|
||||
],
|
||||
"totals": [
|
||||
"variants.purchasable"
|
||||
]
|
||||
},
|
||||
"required": [
|
||||
@@ -14796,6 +14803,9 @@
|
||||
"variants",
|
||||
"variants.options",
|
||||
"variants.prices"
|
||||
],
|
||||
"totals": [
|
||||
"variants.purchasable"
|
||||
]
|
||||
},
|
||||
"required": [
|
||||
@@ -14973,6 +14983,9 @@
|
||||
"prices",
|
||||
"options",
|
||||
"product"
|
||||
],
|
||||
"totals": [
|
||||
"purchasable"
|
||||
]
|
||||
},
|
||||
"required": [
|
||||
@@ -14995,6 +15008,9 @@
|
||||
"prices",
|
||||
"options",
|
||||
"product"
|
||||
],
|
||||
"totals": [
|
||||
"purchasable"
|
||||
]
|
||||
},
|
||||
"required": [
|
||||
@@ -15160,7 +15176,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
@@ -15416,7 +15432,7 @@
|
||||
"nullable": true,
|
||||
"type": "string",
|
||||
"externalDocs": {
|
||||
"url": "https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key",
|
||||
"url": "https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key",
|
||||
"description": "Learn more how to use the idempotency key."
|
||||
}
|
||||
},
|
||||
|
||||
@@ -130,7 +130,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
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.
|
||||
|
||||
@@ -141,5 +141,5 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
|
||||
@@ -1,10 +0,0 @@
|
||||
title: Product with decorated variants
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: ./Product.yaml
|
||||
- type: object
|
||||
properties:
|
||||
variants:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./DecoratedVariant.yaml
|
||||
@@ -1,9 +0,0 @@
|
||||
title: Decorated Product Variant
|
||||
type: object
|
||||
allOf:
|
||||
- $ref: ./PricedVariant.yaml
|
||||
- type: object
|
||||
properties:
|
||||
purchasable:
|
||||
type: boolean
|
||||
description: Boolean indicating if variant is purchasable.
|
||||
@@ -71,7 +71,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -126,7 +126,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -26,7 +26,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: Date which the idempotency key was locked.
|
||||
|
||||
@@ -245,7 +245,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
external_id:
|
||||
description: The ID of an external order.
|
||||
|
||||
@@ -102,7 +102,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -82,7 +82,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
amount:
|
||||
description: The amount that the Payment Session has been authorized for.
|
||||
|
||||
@@ -189,3 +189,13 @@ properties:
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
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
|
||||
|
||||
@@ -67,7 +67,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -103,7 +103,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
received_at:
|
||||
description: The date with timezone at which the return was received.
|
||||
|
||||
@@ -11,6 +11,8 @@ x-expanded-relations:
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
totals:
|
||||
- variants.purchasable
|
||||
required:
|
||||
- products
|
||||
- count
|
||||
|
||||
@@ -11,6 +11,8 @@ x-expanded-relations:
|
||||
- variants
|
||||
- variants.options
|
||||
- variants.prices
|
||||
totals:
|
||||
- variants.purchasable
|
||||
required:
|
||||
- product
|
||||
properties:
|
||||
|
||||
@@ -5,6 +5,8 @@ x-expanded-relations:
|
||||
- prices
|
||||
- options
|
||||
- product
|
||||
totals:
|
||||
- purchasable
|
||||
required:
|
||||
- variants
|
||||
properties:
|
||||
|
||||
@@ -5,6 +5,8 @@ x-expanded-relations:
|
||||
- prices
|
||||
- options
|
||||
- product
|
||||
totals:
|
||||
- purchasable
|
||||
required:
|
||||
- variant
|
||||
properties:
|
||||
|
||||
@@ -154,7 +154,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
@@ -44,7 +44,7 @@ properties:
|
||||
type: string
|
||||
externalDocs:
|
||||
url: >-
|
||||
https://docs.medusajs.com/advanced/backend/payment/overview#idempotency-key
|
||||
https://docs.medusajs.com/modules/carts-and-checkout/cart.md#idempotency-key
|
||||
description: Learn more how to use the idempotency key.
|
||||
created_at:
|
||||
description: The date with timezone at which the resource was created.
|
||||
|
||||
Reference in New Issue
Block a user