chore(docs): Updated API Reference (automated) (#11167)
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:
45 files changed
+5201
-216
No files matched your search
+28
@@ -0,0 +1,28 @@
|
||||
/**
|
||||
* @schema 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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
/**
|
||||
* @schema 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
|
||||
*
|
||||
*/
|
||||
|
||||
+26
@@ -0,0 +1,26 @@
|
||||
/**
|
||||
* @schema 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.
|
||||
*
|
||||
*/
|
||||
|
||||
+32
@@ -0,0 +1,32 @@
|
||||
/**
|
||||
* @schema 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
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -24,9 +24,16 @@
|
||||
* 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
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema 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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema StoreProductTagResponse
|
||||
* type: object
|
||||
* description: The product tag's details.
|
||||
* x-schemaName: StoreProductTagResponse
|
||||
* required:
|
||||
* - product_tag
|
||||
* properties:
|
||||
* product_tag:
|
||||
* $ref: "#/components/schemas/StoreProductTag"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,31 @@
|
||||
/**
|
||||
* @schema 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"
|
||||
*
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,13 @@
|
||||
/**
|
||||
* @schema StoreProductTypeResponse
|
||||
* type: object
|
||||
* description: The product type's details.
|
||||
* x-schemaName: StoreProductTypeResponse
|
||||
* required:
|
||||
* - product_type
|
||||
* properties:
|
||||
* product_type:
|
||||
* $ref: "#/components/schemas/StoreProduct"
|
||||
*
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user