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

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

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-27 11:45:04 +00:00
committed by GitHub
parent 43aa993971
commit 3e81962503
45 changed files with 5201 additions and 216 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
www/apps/api-reference/specs/admin/components/schemas/AdminBatchCreateInventoryItemsLocationLevels.yaml Normal file
View File

@@ -0,0 +1,23 @@
type: object
description: The details of an inventory level to create.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
x-schemaName: AdminBatchCreateInventoryItemsLocationLevels

31
www/apps/api-reference/specs/admin/components/schemas/AdminBatchInventoryItemsLocationLevels.yaml Normal file
View File

@@ -0,0 +1,31 @@
type: object
description: The inventory levels to manage.
properties:
create:
type: array
description: The inventory levels to create.
items:
$ref: ./AdminBatchCreateInventoryItemsLocationLevels.yaml
update:
type: array
description: The inventory levels to update.
items:
$ref: ./AdminBatchUpdateInventoryItemsLocationLevels.yaml
delete:
type: array
description: The IDs of 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.
required:
- create
- update
- delete
x-schemaName: AdminBatchInventoryItemsLocationLevels

21
www/apps/api-reference/specs/admin/components/schemas/AdminBatchInventoryItemsLocationLevelsResponse.yaml Normal file
View File

@@ -0,0 +1,21 @@
type: object
description: The result of managing inventory levels.
x-schemaName: AdminBatchInventoryItemsLocationLevelsResponse
properties:
created:
type: array
description: The created inventory levels.
items:
$ref: ./InventoryLevel.yaml
updated:
type: array
description: The updated inventory levels.
items:
$ref: ./InventoryLevel.yaml
deleted:
type: array
description: The IDs of deleted inventory levels.
items:
type: string
title: deleted
description: The ID of a deleted inventory level.

27
www/apps/api-reference/specs/admin/components/schemas/AdminBatchUpdateInventoryItemsLocationLevels.yaml Normal file
View File

@@ -0,0 +1,27 @@
type: object
description: The details of an inventory level to update.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
id:
type: string
title: id
description: The update's ID.
x-schemaName: AdminBatchUpdateInventoryItemsLocationLevels

13
www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml
View File

@@ -22,9 +22,16 @@ properties:
example: is_return
operator:
type: string
title: operator
description: The shipping option rule's operator.
example: eq
description: The rule's operator.
enum:
- gt
- lt
- eq
- ne
- in
- lte
- gte
- nin
value:
type: string
title: value

26
www/apps/api-reference/specs/admin/components/schemas/StoreProductTagListResponse.yaml Normal file
View File

@@ -0,0 +1,26 @@
type: object
description: The paginated list of product tags.
x-schemaName: StoreProductTagListResponse
required:
- limit
- offset
- count
- product_tags
properties:
limit:
type: number
title: limit
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The number of items to skip before retrieving the returned items.
count:
type: number
title: count
description: The total number of items available.
product_tags:
type: array
description: The list of product tags.
items:
$ref: ./StoreProductTag.yaml

8
www/apps/api-reference/specs/admin/components/schemas/StoreProductTagResponse.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
description: The product tag's details.
x-schemaName: StoreProductTagResponse
required:
- product_tag
properties:
product_tag:
$ref: ./StoreProductTag.yaml

26
www/apps/api-reference/specs/admin/components/schemas/StoreProductTypeListResponse.yaml Normal file
View File

@@ -0,0 +1,26 @@
type: object
description: The paginated list of product types.
x-schemaName: StoreProductTypeListResponse
required:
- limit
- offset
- count
- product_types
properties:
limit:
type: number
title: limit
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The number of items to skip before retrieving the returned items.
count:
type: number
title: count
description: The total number of items available.
product_types:
type: array
description: The list of product types.
items:
$ref: ./StoreProduct.yaml

8
www/apps/api-reference/specs/admin/components/schemas/StoreProductTypeResponse.yaml Normal file
View File

@@ -0,0 +1,8 @@
type: object
description: The product type's details.
x-schemaName: StoreProductTypeResponse
required:
- product_type
properties:
product_type:
$ref: ./StoreProduct.yaml

262
www/apps/api-reference/specs/admin/openapi.full.yaml
View File

@@ -16709,72 +16709,7 @@ paths:
content:
application/json:
schema:
type: object
description: The inventory levels to manage.
properties:
create:
type: array
description: The inventory levels to create.
items:
type: object
description: The details of an inventory level to create.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
update:
type: array
description: The inventory levels to update.
items:
type: object
description: The details of an inventory level to update.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
delete:
type: array
description: The IDs of 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.
$ref: '#/components/schemas/AdminBatchInventoryItemsLocationLevels'
x-codeSamples:
- lang: Shell
label: cURL
@@ -16806,6 +16741,12 @@ paths:
tags:
- Inventory Items
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AdminBatchInventoryItemsLocationLevelsResponse'
'400':
$ref: '#/components/responses/400_error'
'401':
@@ -43819,6 +43760,30 @@ 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`.
AdminBatchCreateInventoryItemsLocationLevels:
type: object
description: The details of an inventory level to create.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
x-schemaName: AdminBatchCreateInventoryItemsLocationLevels
AdminBatchInventoryItemLocationsLevel:
type: object
description: The inventory levels to create, update, or delete.
@@ -43881,6 +43846,58 @@ components:
title: force
description: Whether to delete specified inventory levels even if they have a non-zero stocked quantity.
x-schemaName: AdminBatchInventoryItemLocationsLevel
AdminBatchInventoryItemsLocationLevels:
type: object
description: The inventory levels to manage.
properties:
create:
type: array
description: The inventory levels to create.
items:
$ref: '#/components/schemas/AdminBatchCreateInventoryItemsLocationLevels'
update:
type: array
description: The inventory levels to update.
items:
$ref: '#/components/schemas/AdminBatchUpdateInventoryItemsLocationLevels'
delete:
type: array
description: The IDs of 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.
required:
- create
- update
- delete
x-schemaName: AdminBatchInventoryItemsLocationLevels
AdminBatchInventoryItemsLocationLevelsResponse:
type: object
description: The result of managing inventory levels.
x-schemaName: AdminBatchInventoryItemsLocationLevelsResponse
properties:
created:
type: array
description: The created inventory levels.
items:
$ref: '#/components/schemas/InventoryLevel'
updated:
type: array
description: The updated inventory levels.
items:
$ref: '#/components/schemas/InventoryLevel'
deleted:
type: array
description: The IDs of deleted inventory levels.
items:
type: string
title: deleted
description: The ID of a deleted inventory level.
AdminBatchProductRequest:
type: object
description: The products to create, update, or delete.
@@ -44011,6 +44028,34 @@ components:
type: boolean
title: deleted
description: Whether the product variants were deleted.
AdminBatchUpdateInventoryItemsLocationLevels:
type: object
description: The details of an inventory level to update.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
id:
type: string
title: id
description: The update's ID.
x-schemaName: AdminBatchUpdateInventoryItemsLocationLevels
AdminBatchUpdateProduct:
type: object
description: The product's details.
@@ -53282,9 +53327,16 @@ components:
example: is_return
operator:
type: string
title: operator
description: The shipping option rule's operator.
example: eq
description: The rule's operator.
enum:
- gt
- lt
- eq
- ne
- in
- lte
- gte
- nin
value:
type: string
title: value
@@ -69028,6 +69080,78 @@ components:
- value
- created_at
- updated_at
StoreProductTagListResponse:
type: object
description: The paginated list of product tags.
x-schemaName: StoreProductTagListResponse
required:
- limit
- offset
- count
- product_tags
properties:
limit:
type: number
title: limit
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The number of items to skip before retrieving the returned items.
count:
type: number
title: count
description: The total number of items available.
product_tags:
type: array
description: The list of product tags.
items:
$ref: '#/components/schemas/StoreProductTag'
StoreProductTagResponse:
type: object
description: The product tag's details.
x-schemaName: StoreProductTagResponse
required:
- product_tag
properties:
product_tag:
$ref: '#/components/schemas/StoreProductTag'
StoreProductTypeListResponse:
type: object
description: The paginated list of product types.
x-schemaName: StoreProductTypeListResponse
required:
- limit
- offset
- count
- product_types
properties:
limit:
type: number
title: limit
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The number of items to skip before retrieving the returned items.
count:
type: number
title: count
description: The total number of items available.
product_types:
type: array
description: The list of product types.
items:
$ref: '#/components/schemas/StoreProduct'
StoreProductTypeResponse:
type: object
description: The product type's details.
x-schemaName: StoreProductTypeResponse
required:
- product_type
properties:
product_type:
$ref: '#/components/schemas/StoreProduct'
StoreProductVariant:
type: object
description: The variant's details.

76
www/apps/api-reference/specs/admin/paths/admin_inventory-items_location-levels_batch.yaml
View File

@@ -11,74 +11,7 @@ post:
content:
application/json:
schema:
type: object
description: The inventory levels to manage.
properties:
create:
type: array
description: The inventory levels to create.
items:
type: object
description: The details of an inventory level to create.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
update:
type: array
description: The inventory levels to update.
items:
type: object
description: The details of an inventory level to update.
required:
- location_id
- inventory_item_id
properties:
location_id:
type: string
title: location_id
description: The ID of the associated stock location.
inventory_item_id:
type: string
title: inventory_item_id
description: The ID of the associated inventory item.
stocked_quantity:
type: number
title: stocked_quantity
description: The stocked quantity.
incoming_quantity:
type: number
title: incoming_quantity
description: The incoming quantity to be added to stock.
delete:
type: array
description: The IDs of 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.
$ref: ../components/schemas/AdminBatchInventoryItemsLocationLevels.yaml
x-codeSamples:
- lang: Shell
label: cURL
@@ -88,6 +21,13 @@ post:
tags:
- Inventory Items
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminBatchInventoryItemsLocationLevelsResponse.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':