asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore(docs): Updated API Reference (automated) (#11030)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-01-17 16:35:02 +00:00
committed by GitHub
co-authored by Oli Juhl Shahed Nasser
parent bff8c0bc93
commit 24441e48df
42 changed files with 953 additions and 460 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/api-reference/specs/store/openapi.full.yaml
+105 -53
View File
@@ -6373,6 +6373,68 @@ components:
type: number
title: apply_to_quantity
description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`.
AdminBatchInventoryItemLocationsLevel:
type: object
description: The inventory levels to create, update, or delete.
properties:
create:
type: array
description: The inventory levels to create.
items:
type: object
description: The inventory level's details.
required:
- location_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated location.
stocked_quantity:
type: number
title: stocked_quantity
description: The inventory level's stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The inventory level's incoming quantity.
update:
type: array
description: The inventory levels to update.
items:
type: object
description: The inventory level's details.
properties:
stocked_quantity:
type: number
title: stocked_quantity
description: The inventory level's stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The inventory level's incoming quantity.
location_id:
type: string
title: location_id
description: The associated stock location's ID.
id:
type: string
title: id
description: The ID of the location level.
required:
- location_id
delete:
type: array
description: The inventory levels to delete.
items:
type: string
title: delete
description: The ID of the inventory level to delete.
force:
type: boolean
title: force
description: Whether to delete specified inventory levels even if they have a non-zero stocked quantity.
x-schemaName: AdminBatchInventoryItemLocationsLevel
AdminBatchProductRequest:
type: object
description: The products to create, update, or delete.
@@ -10206,7 +10268,7 @@ components:
description: The number of products that will be updated by this import.
AdminInventoryItem:
type: object
description: The reservation's inventory item.
description: The inventory item's details.
x-schemaName: AdminInventoryItem
required:
- id
@@ -10227,15 +10289,15 @@ components:
hs_code:
type: string
title: hs_code
description: The inventory item's hs code.
description: The inventory item's HS code.
requires_shipping:
type: boolean
title: requires_shipping
description: The inventory item's requires shipping.
description: Whether the inventory item requires shipping.
mid_code:
type: string
title: mid_code
description: The inventory item's mid code.
description: The inventory item's MID code.
material:
type: string
title: material
@@ -10267,10 +10329,10 @@ components:
thumbnail:
type: string
title: thumbnail
description: The inventory item's thumbnail.
description: The thumbnail URL of the inventory item.
metadata:
type: object
description: The inventory item's metadata.
description: Custom key-value pairs, used to store additional information about the inventory item.
location_levels:
type: array
description: The inventory item's location levels.
@@ -12246,22 +12308,6 @@ components:
type: string
title: provider_id
description: The ID of the payment provider used to process this payment.
cart_id:
type: string
title: cart_id
description: The ID of the associated cart.
order_id:
type: string
title: order_id
description: The ID of the associated order.
order_edit_id:
type: string
title: order_edit_id
description: The ID of the associated order edit.
customer_id:
type: string
title: customer_id
description: ID of the associated customer.
data:
type: object
description: The payment's data, useful for processing by the payment provider.
@@ -12317,7 +12363,6 @@ components:
- payment_providers
- id
- currency_code
- region_id
- amount
- status
properties:
@@ -12329,10 +12374,6 @@ components:
type: string
title: currency_code
description: The payment collection's currency code.
region_id:
type: string
title: region_id
description: The ID of the region this payment collection is associated with.
amount:
type: number
title: amount
@@ -14461,6 +14502,11 @@ components:
metadata:
type: object
description: The variant's metadata, can hold custom key-value pairs.
inventory_items:
type: array
description: The variant's inventory items.
items:
$ref: '#/components/schemas/AdminProductVariantInventoryItemLink'
AdminProductVariantDeleteResponse:
type: object
description: The details of the product variant's deletion.
@@ -14593,6 +14639,31 @@ components:
type: string
title: inventory_item_id
description: The ID of the inventory item.
AdminProductVariantInventoryItemLink:
type: object
description: An association between a product variant and an inventory item.
x-schemaName: AdminProductVariantInventoryItemLink
required:
- id
- variant_id
- inventory_item_id
properties:
id:
type: string
title: id
description: The ID of the association.
variant_id:
type: string
title: variant_id
description: The associated product variant's ID.
variant:
type: object
inventory_item_id:
type: string
title: inventory_item_id
description: The associated inventory item's ID.
inventory:
$ref: '#/components/schemas/AdminInventoryItem'
AdminProductVariantInventoryLink:
type: object
description: The details of an association between a product variant and an inventory item.
@@ -14710,6 +14781,13 @@ components:
format: date-time
title: deleted_at
description: The date the promotion was deleted.
status:
type: string
description: The promotion's status.
enum:
- draft
- active
- inactive
AdminPromotionResponse:
type: object
description: The promotion's details.
@@ -19767,22 +19845,6 @@ components:
type: string
title: provider_id
description: The ID of the payment provider used to process this payment.
cart_id:
type: string
title: cart_id
description: The ID of the associated cart.
order_id:
type: string
title: order_id
description: The ID of the associated order.
order_edit_id:
type: string
title: order_edit_id
description: The ID of the associated order edit.
customer_id:
type: string
title: customer_id
description: ID of the associated customer.
data:
type: object
description: The payment's data, useful for processing by the payment provider.
@@ -19837,7 +19899,6 @@ components:
required:
- id
- currency_code
- region_id
- amount
- status
- payment_providers
@@ -19850,10 +19911,6 @@ components:
type: string
title: currency_code
description: The payment collection's currency code.
region_id:
type: string
title: region_id
description: The ID of the region this payment collection is associated with.
amount:
type: number
title: amount
@@ -30870,7 +30927,6 @@ components:
- payment_providers
- id
- currency_code
- region_id
- amount
- status
properties:
@@ -30882,10 +30938,6 @@ components:
type: string
title: currency_code
description: The payment collection's currency code.
region_id:
type: string
title: region_id
description: The ID of the region this payment collection is associated with.
amount:
type: number
title: amount