asyavee/medusa-store
1
0 Fork 0
Code Issues Pull Requests Actions 3 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]Oli JuhlShahed Nasser
 authored and GitHub committed 2025-01-17 16:35:02 +00:00
1 parent bff8c0bc93
commit 24441e48df
42 files changed
+953 -460
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

www/utils/generated/oas-output/schemas/AdminBatchInventoryItemLocationsLevel.ts
+66
View File
@@ -0,0 +1,66 @@
/**
* @schema 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
*
*/
www/utils/generated/oas-output/schemas/AdminInventoryItem.ts
+6 -6
View File
@@ -1,7 +1,7 @@
/**
* @schema AdminInventoryItem
* type: object
* description: The reservation's inventory item.
* description: The inventory item's details.
* x-schemaName: AdminInventoryItem
* required:
* - id
@@ -22,15 +22,15 @@
* 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
@@ -62,10 +62,10 @@
* 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.
www/utils/generated/oas-output/schemas/AdminPayment.ts
-16
View File
@@ -29,22 +29,6 @@
* 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.
www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts
-5
View File
@@ -7,7 +7,6 @@
* - payment_providers
* - id
* - currency_code
* - region_id
* - amount
* - status
* properties:
@@ -19,10 +18,6 @@
* 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
www/utils/generated/oas-output/schemas/AdminProductVariant.ts
+5
View File
@@ -134,6 +134,11 @@
* 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"
*
*/
www/utils/generated/oas-output/schemas/AdminProductVariantInventoryItemLink.ts
+29
View File
@@ -0,0 +1,29 @@
/**
* @schema 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:
* $ref: "#/components/schemas/AdminProductVariant"
* inventory_item_id:
* type: string
* title: inventory_item_id
* description: The associated inventory item's ID.
* inventory:
* $ref: "#/components/schemas/AdminInventoryItem"
*
*/
www/utils/generated/oas-output/schemas/AdminPromotion.ts
+7
View File
@@ -56,6 +56,13 @@
* 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
*
*/
www/utils/generated/oas-output/schemas/BasePayment.ts
-16
View File
@@ -29,22 +29,6 @@
* 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.
www/utils/generated/oas-output/schemas/BasePaymentCollection.ts
-5
View File
@@ -6,7 +6,6 @@
* required:
* - id
* - currency_code
* - region_id
* - amount
* - status
* - payment_providers
@@ -19,10 +18,6 @@
* 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
www/utils/generated/oas-output/schemas/StorePaymentCollection.ts
-5
View File
@@ -7,7 +7,6 @@
* - payment_providers
* - id
* - currency_code
* - region_id
* - amount
* - status
* properties:
@@ -19,10 +18,6 @@
* 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