Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
type: object
description: The product tag's details.
x-schemaName: StoreProductTagResponse
required:
- product_tag
properties:
product_tag:
$ref: ./StoreProductTag.yaml
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
type: object
description: The product type's details.
x-schemaName: StoreProductTypeResponse
required:
- product_type
properties:
product_type:
$ref: ./StoreProduct.yaml
Loading
Loading