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
+23
@@ -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
@@ -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
@@ -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
@@ -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
|
||||||
@@ -22,9 +22,16 @@ properties:
|
|||||||
example: is_return
|
example: is_return
|
||||||
operator:
|
operator:
|
||||||
type: string
|
type: string
|
||||||
title: operator
|
description: The rule's operator.
|
||||||
description: The shipping option rule's operator.
|
enum:
|
||||||
example: eq
|
- gt
|
||||||
|
- lt
|
||||||
|
- eq
|
||||||
|
- ne
|
||||||
|
- in
|
||||||
|
- lte
|
||||||
|
- gte
|
||||||
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
type: string
|
||||||
title: value
|
title: value
|
||||||
|
|||||||
+26
@@ -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
|
||||||
@@ -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
@@ -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
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
type: object
|
||||||
|
description: The product type's details.
|
||||||
|
x-schemaName: StoreProductTypeResponse
|
||||||
|
required:
|
||||||
|
- product_type
|
||||||
|
properties:
|
||||||
|
product_type:
|
||||||
|
$ref: ./StoreProduct.yaml
|
||||||
@@ -16709,72 +16709,7 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: '#/components/schemas/AdminBatchInventoryItemsLocationLevels'
|
||||||
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.
|
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
@@ -16806,6 +16741,12 @@ paths:
|
|||||||
tags:
|
tags:
|
||||||
- Inventory Items
|
- Inventory Items
|
||||||
responses:
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/AdminBatchInventoryItemsLocationLevelsResponse'
|
||||||
'400':
|
'400':
|
||||||
$ref: '#/components/responses/400_error'
|
$ref: '#/components/responses/400_error'
|
||||||
'401':
|
'401':
|
||||||
@@ -43819,6 +43760,30 @@ components:
|
|||||||
type: number
|
type: number
|
||||||
title: apply_to_quantity
|
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`.
|
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:
|
AdminBatchInventoryItemLocationsLevel:
|
||||||
type: object
|
type: object
|
||||||
description: The inventory levels to create, update, or delete.
|
description: The inventory levels to create, update, or delete.
|
||||||
@@ -43881,6 +43846,58 @@ components:
|
|||||||
title: force
|
title: force
|
||||||
description: Whether to delete specified inventory levels even if they have a non-zero stocked quantity.
|
description: Whether to delete specified inventory levels even if they have a non-zero stocked quantity.
|
||||||
x-schemaName: AdminBatchInventoryItemLocationsLevel
|
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:
|
AdminBatchProductRequest:
|
||||||
type: object
|
type: object
|
||||||
description: The products to create, update, or delete.
|
description: The products to create, update, or delete.
|
||||||
@@ -44011,6 +44028,34 @@ components:
|
|||||||
type: boolean
|
type: boolean
|
||||||
title: deleted
|
title: deleted
|
||||||
description: Whether the product variants were 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:
|
AdminBatchUpdateProduct:
|
||||||
type: object
|
type: object
|
||||||
description: The product's details.
|
description: The product's details.
|
||||||
@@ -53282,9 +53327,16 @@ components:
|
|||||||
example: is_return
|
example: is_return
|
||||||
operator:
|
operator:
|
||||||
type: string
|
type: string
|
||||||
title: operator
|
description: The rule's operator.
|
||||||
description: The shipping option rule's operator.
|
enum:
|
||||||
example: eq
|
- gt
|
||||||
|
- lt
|
||||||
|
- eq
|
||||||
|
- ne
|
||||||
|
- in
|
||||||
|
- lte
|
||||||
|
- gte
|
||||||
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
type: string
|
||||||
title: value
|
title: value
|
||||||
@@ -69028,6 +69080,78 @@ components:
|
|||||||
- value
|
- value
|
||||||
- created_at
|
- created_at
|
||||||
- updated_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:
|
StoreProductVariant:
|
||||||
type: object
|
type: object
|
||||||
description: The variant's details.
|
description: The variant's details.
|
||||||
|
|||||||
+8
-68
@@ -11,74 +11,7 @@ post:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: ../components/schemas/AdminBatchInventoryItemsLocationLevels.yaml
|
||||||
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.
|
|
||||||
x-codeSamples:
|
x-codeSamples:
|
||||||
- lang: Shell
|
- lang: Shell
|
||||||
label: cURL
|
label: cURL
|
||||||
@@ -88,6 +21,13 @@ post:
|
|||||||
tags:
|
tags:
|
||||||
- Inventory Items
|
- Inventory Items
|
||||||
responses:
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: >-
|
||||||
|
../components/schemas/AdminBatchInventoryItemsLocationLevelsResponse.yaml
|
||||||
'400':
|
'400':
|
||||||
$ref: ../components/responses/400_error.yaml
|
$ref: ../components/responses/400_error.yaml
|
||||||
'401':
|
'401':
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
curl '{backend_url}/store/product-tags' \
|
||||||
|
-H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
curl '{backend_url}/store/product-tags/{id}' \
|
||||||
|
-H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
curl '{backend_url}/store/product-types' \
|
||||||
|
-H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
@@ -0,0 +1,2 @@
|
|||||||
|
curl '{backend_url}/store/product-types/{id}' \
|
||||||
|
-H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
+23
@@ -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
@@ -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
@@ -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
@@ -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
|
||||||
@@ -22,9 +22,16 @@ properties:
|
|||||||
example: is_return
|
example: is_return
|
||||||
operator:
|
operator:
|
||||||
type: string
|
type: string
|
||||||
title: operator
|
description: The rule's operator.
|
||||||
description: The shipping option rule's operator.
|
enum:
|
||||||
example: eq
|
- gt
|
||||||
|
- lt
|
||||||
|
- eq
|
||||||
|
- ne
|
||||||
|
- in
|
||||||
|
- lte
|
||||||
|
- gte
|
||||||
|
- nin
|
||||||
value:
|
value:
|
||||||
type: string
|
type: string
|
||||||
title: value
|
title: value
|
||||||
|
|||||||
+26
@@ -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
|
||||||
@@ -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
@@ -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
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
type: object
|
||||||
|
description: The product type's details.
|
||||||
|
x-schemaName: StoreProductTypeResponse
|
||||||
|
required:
|
||||||
|
- product_type
|
||||||
|
properties:
|
||||||
|
product_type:
|
||||||
|
$ref: ./StoreProduct.yaml
|
||||||
File diff suppressed because it is too large.
Load diff
@@ -122,6 +122,10 @@ tags:
|
|||||||
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
|
https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
|
||||||
x-associatedSchema:
|
x-associatedSchema:
|
||||||
$ref: ./components/schemas/StoreProductCategory.yaml
|
$ref: ./components/schemas/StoreProductCategory.yaml
|
||||||
|
- name: Product Tags
|
||||||
|
x-associatedSchema:
|
||||||
|
$ref: ./components/schemas/StoreProductTag.yaml
|
||||||
|
- name: Product Types
|
||||||
- name: Products
|
- name: Products
|
||||||
description: >
|
description: >
|
||||||
Customers browse products for their purchase.
|
Customers browse products for their purchase.
|
||||||
@@ -259,6 +263,14 @@ paths:
|
|||||||
$ref: paths/store_product-categories.yaml
|
$ref: paths/store_product-categories.yaml
|
||||||
/store/product-categories/{id}:
|
/store/product-categories/{id}:
|
||||||
$ref: paths/store_product-categories_{id}.yaml
|
$ref: paths/store_product-categories_{id}.yaml
|
||||||
|
/store/product-tags:
|
||||||
|
$ref: paths/store_product-tags.yaml
|
||||||
|
/store/product-tags/{id}:
|
||||||
|
$ref: paths/store_product-tags_{id}.yaml
|
||||||
|
/store/product-types:
|
||||||
|
$ref: paths/store_product-types.yaml
|
||||||
|
/store/product-types/{id}:
|
||||||
|
$ref: paths/store_product-types_{id}.yaml
|
||||||
/store/products:
|
/store/products:
|
||||||
$ref: paths/store_products.yaml
|
$ref: paths/store_products.yaml
|
||||||
/store/products/{id}:
|
/store/products/{id}:
|
||||||
|
|||||||
@@ -0,0 +1,699 @@
|
|||||||
|
get:
|
||||||
|
operationId: GetProductTags
|
||||||
|
summary: List Product Tags
|
||||||
|
description: >-
|
||||||
|
Retrieve a list of product tags. The product tags can be filtered by fields
|
||||||
|
such as `id`. The product tags can also be sorted or paginated.
|
||||||
|
x-authenticated: false
|
||||||
|
parameters:
|
||||||
|
- name: x-publishable-api-key
|
||||||
|
in: header
|
||||||
|
description: Publishable API Key created in the Medusa Admin.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
externalDocs:
|
||||||
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
|
||||||
|
if a field is prefixed with `+` it will be added to the default fields,
|
||||||
|
using `-` will remove it from the default fields.
|
||||||
|
|
||||||
|
without prefix it will replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
If a field is prefixed with `+` it will be added to the default
|
||||||
|
fields, using `-` will remove it from the default fields. Without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
|
externalDocs:
|
||||||
|
url: '#select-fields-and-relations'
|
||||||
|
- name: offset
|
||||||
|
in: query
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: limit
|
||||||
|
in: query
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: order
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is ascending.
|
||||||
|
To change the order to descending, prefix the field name with `-`.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: order
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is
|
||||||
|
ascending. To change the order to descending, prefix the field name
|
||||||
|
with `-`.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: $and
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content is
|
||||||
|
the same type as the expected query parameters.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content is
|
||||||
|
the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
- name: $or
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content is the
|
||||||
|
same type as the expected query parameters.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content is
|
||||||
|
the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
- name: q
|
||||||
|
in: query
|
||||||
|
description: Query to search product tag's searchable fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: q
|
||||||
|
description: Query to search product tag's searchable fields.
|
||||||
|
- name: id
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: id
|
||||||
|
description: Filter by a product tag's ID.
|
||||||
|
- type: array
|
||||||
|
description: Filter by product tag IDs.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: A product tag's ID.
|
||||||
|
- name: value
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: value
|
||||||
|
description: Filter by a product tag's value.
|
||||||
|
- type: array
|
||||||
|
description: Filter by product tag values.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: A product tag's value.
|
||||||
|
- name: created_at
|
||||||
|
in: query
|
||||||
|
description: Filter by the tag's creation date.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
description: Filter by the tag's creation date.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: An exact match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not equal to this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value not to match.
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: The value to match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value to not match
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
- type: array
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: >-
|
||||||
|
Apply a case-insensitive `like` filter. Useful for strings
|
||||||
|
only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that have overlapping values with this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The value to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that contain some of the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: >-
|
||||||
|
Filter by whether a value for this parameter exists (not
|
||||||
|
`null`).
|
||||||
|
- type: array
|
||||||
|
description: Filter by values not matching those in this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for numbers
|
||||||
|
and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter. Useful
|
||||||
|
for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for numbers and
|
||||||
|
dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The values to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
- name: updated_at
|
||||||
|
in: query
|
||||||
|
description: Filter by the tag's update date.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
description: Filter by the tag's update date.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: An exact match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not equal to this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value not to match.
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: The value to match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value to not match
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
- type: array
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: >-
|
||||||
|
Apply a case-insensitive `like` filter. Useful for strings
|
||||||
|
only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that have overlapping values with this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The value to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that contain some of the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: >-
|
||||||
|
Filter by whether a value for this parameter exists (not
|
||||||
|
`null`).
|
||||||
|
- type: array
|
||||||
|
description: Filter by values not matching those in this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for numbers
|
||||||
|
and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter. Useful
|
||||||
|
for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for numbers and
|
||||||
|
dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The values to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/Shell/store_product-tags/get.sh
|
||||||
|
tags:
|
||||||
|
- Product Tags
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../components/schemas/StoreProductTagListResponse.yaml
|
||||||
|
'400':
|
||||||
|
$ref: ../components/responses/400_error.yaml
|
||||||
|
'401':
|
||||||
|
$ref: ../components/responses/unauthorized.yaml
|
||||||
|
'404':
|
||||||
|
$ref: ../components/responses/not_found_error.yaml
|
||||||
|
'409':
|
||||||
|
$ref: ../components/responses/invalid_state_error.yaml
|
||||||
|
'422':
|
||||||
|
$ref: ../components/responses/invalid_request_error.yaml
|
||||||
|
'500':
|
||||||
|
$ref: ../components/responses/500_error.yaml
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
get:
|
||||||
|
operationId: GetProductTagsId
|
||||||
|
summary: Get a Product Tag
|
||||||
|
description: >-
|
||||||
|
Retrieve a product tag by its ID. You can expand the product tag's relations
|
||||||
|
or select the fields that should be returned.
|
||||||
|
x-authenticated: false
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
description: The product tag's ID.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: x-publishable-api-key
|
||||||
|
in: header
|
||||||
|
description: Publishable API Key created in the Medusa Admin.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
externalDocs:
|
||||||
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
|
||||||
|
if a field is prefixed with `+` it will be added to the default fields,
|
||||||
|
using `-` will remove it from the default fields.
|
||||||
|
|
||||||
|
without prefix it will replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
If a field is prefixed with `+` it will be added to the default
|
||||||
|
fields, using `-` will remove it from the default fields. Without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
|
externalDocs:
|
||||||
|
url: '#select-fields-and-relations'
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/Shell/store_product-tags_{id}/get.sh
|
||||||
|
tags:
|
||||||
|
- Product Tags
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../components/schemas/StoreProductTagResponse.yaml
|
||||||
|
'400':
|
||||||
|
$ref: ../components/responses/400_error.yaml
|
||||||
|
'401':
|
||||||
|
$ref: ../components/responses/unauthorized.yaml
|
||||||
|
'404':
|
||||||
|
$ref: ../components/responses/not_found_error.yaml
|
||||||
|
'409':
|
||||||
|
$ref: ../components/responses/invalid_state_error.yaml
|
||||||
|
'422':
|
||||||
|
$ref: ../components/responses/invalid_request_error.yaml
|
||||||
|
'500':
|
||||||
|
$ref: ../components/responses/500_error.yaml
|
||||||
@@ -0,0 +1,696 @@
|
|||||||
|
get:
|
||||||
|
operationId: GetProductTypes
|
||||||
|
summary: List Product Types
|
||||||
|
description: >-
|
||||||
|
Retrieve a list of product types. The product types can be filtered by
|
||||||
|
fields such as `id`. The product types can also be sorted or paginated.
|
||||||
|
x-authenticated: false
|
||||||
|
parameters:
|
||||||
|
- name: x-publishable-api-key
|
||||||
|
in: header
|
||||||
|
description: Publishable API Key created in the Medusa Admin.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
externalDocs:
|
||||||
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: |-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
without prefix it will replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
If a field is prefixed with `+` it will be added to the default
|
||||||
|
fields, using `-` will remove it from the default fields. Without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
|
externalDocs:
|
||||||
|
url: '#select-fields-and-relations'
|
||||||
|
- name: offset
|
||||||
|
in: query
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: offset
|
||||||
|
description: The number of items to skip when retrieving a list.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: limit
|
||||||
|
in: query
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: number
|
||||||
|
title: limit
|
||||||
|
description: Limit the number of items returned in the list.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: order
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is ascending.
|
||||||
|
To change the order to descending, prefix the field name with `-`.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: order
|
||||||
|
description: >-
|
||||||
|
The field to sort the data by. By default, the sort order is
|
||||||
|
ascending. To change the order to descending, prefix the field name
|
||||||
|
with `-`.
|
||||||
|
externalDocs:
|
||||||
|
url: '#pagination'
|
||||||
|
- name: $and
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content is
|
||||||
|
the same type as the expected query parameters.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content is
|
||||||
|
the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
- name: $or
|
||||||
|
in: query
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content is the
|
||||||
|
same type as the expected query parameters.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content is
|
||||||
|
the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
- name: q
|
||||||
|
in: query
|
||||||
|
description: Query to search the product type's searchable fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: q
|
||||||
|
description: Query to search the product type's searchable fields.
|
||||||
|
- name: id
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: id
|
||||||
|
description: Filter by a product type's ID.
|
||||||
|
- type: array
|
||||||
|
description: Filter by product type IDs.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: id
|
||||||
|
description: A product type's ID.
|
||||||
|
- name: value
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: value
|
||||||
|
description: Filter by a product type's value.
|
||||||
|
- type: array
|
||||||
|
description: Filter by product type values.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: value
|
||||||
|
description: A product type's value.
|
||||||
|
- name: created_at
|
||||||
|
in: query
|
||||||
|
description: Filter by the type's creation date.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
description: Filter by the type's creation date.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: An exact match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not equal to this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value not to match.
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: The value to match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value to not match
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
- type: array
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: >-
|
||||||
|
Apply a case-insensitive `like` filter. Useful for strings
|
||||||
|
only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that have overlapping values with this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The value to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that contain some of the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: >-
|
||||||
|
Filter by whether a value for this parameter exists (not
|
||||||
|
`null`).
|
||||||
|
- type: array
|
||||||
|
description: Filter by values not matching those in this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for numbers
|
||||||
|
and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter. Useful
|
||||||
|
for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for numbers and
|
||||||
|
dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The values to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
- name: updated_at
|
||||||
|
in: query
|
||||||
|
description: Filter by the type's update date.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
description: Filter by the type's update date.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's content
|
||||||
|
is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: An exact match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not equal to this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value not to match.
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
properties:
|
||||||
|
$and:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an AND condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $and
|
||||||
|
$or:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Join query parameters with an OR condition. Each object's
|
||||||
|
content is the same type as the expected query parameters.
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: $or
|
||||||
|
$eq:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $eq
|
||||||
|
description: Filter by an exact match.
|
||||||
|
- type: array
|
||||||
|
description: Filter by multiple exact matches.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $eq
|
||||||
|
description: The value to match.
|
||||||
|
$ne:
|
||||||
|
type: string
|
||||||
|
title: $ne
|
||||||
|
description: Filter by values not matching this parameter.
|
||||||
|
$in:
|
||||||
|
type: array
|
||||||
|
description: Filter by values in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $in
|
||||||
|
description: The value to match.
|
||||||
|
$nin:
|
||||||
|
type: array
|
||||||
|
description: Filter by values not in this array.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $nin
|
||||||
|
description: The value to not match
|
||||||
|
$not:
|
||||||
|
oneOf:
|
||||||
|
- type: string
|
||||||
|
title: $not
|
||||||
|
description: Filter by values not matching this parameter
|
||||||
|
- type: object
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the conditions in this
|
||||||
|
parameter.
|
||||||
|
- type: array
|
||||||
|
description: >-
|
||||||
|
Filter by values not matching the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter.
|
||||||
|
Useful for numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: >-
|
||||||
|
Apply a case-insensitive `like` filter. Useful for strings
|
||||||
|
only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that have overlapping values with this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The value to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: >-
|
||||||
|
Filter arrays that contain some of the values of this
|
||||||
|
parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: >-
|
||||||
|
Filter by whether a value for this parameter exists (not
|
||||||
|
`null`).
|
||||||
|
- type: array
|
||||||
|
description: Filter by values not matching those in this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $not
|
||||||
|
description: The values to not match.
|
||||||
|
$gt:
|
||||||
|
type: string
|
||||||
|
title: $gt
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than this parameter. Useful for numbers
|
||||||
|
and dates only.
|
||||||
|
$gte:
|
||||||
|
type: string
|
||||||
|
title: $gte
|
||||||
|
description: >-
|
||||||
|
Filter by values greater than or equal to this parameter. Useful
|
||||||
|
for numbers and dates only.
|
||||||
|
$lt:
|
||||||
|
type: string
|
||||||
|
title: $lt
|
||||||
|
description: >-
|
||||||
|
Filter by values less than this parameter. Useful for numbers and
|
||||||
|
dates only.
|
||||||
|
$lte:
|
||||||
|
type: string
|
||||||
|
title: $lte
|
||||||
|
description: >-
|
||||||
|
Filter by values less than or equal to this parameter. Useful for
|
||||||
|
numbers and dates only.
|
||||||
|
$like:
|
||||||
|
type: string
|
||||||
|
title: $like
|
||||||
|
description: Apply a `like` filter. Useful for strings only.
|
||||||
|
$re:
|
||||||
|
type: string
|
||||||
|
title: $re
|
||||||
|
description: Apply a regex filter. Useful for strings only.
|
||||||
|
$ilike:
|
||||||
|
type: string
|
||||||
|
title: $ilike
|
||||||
|
description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
$fulltext:
|
||||||
|
type: string
|
||||||
|
title: $fulltext
|
||||||
|
description: Filter to apply on full-text properties.
|
||||||
|
$overlap:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $overlap
|
||||||
|
description: The values to match.
|
||||||
|
$contains:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contains
|
||||||
|
description: The values to match.
|
||||||
|
$contained:
|
||||||
|
type: array
|
||||||
|
description: Filter arrays that contain all values of this parameter.
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
title: $contained
|
||||||
|
description: The values to match.
|
||||||
|
$exists:
|
||||||
|
type: boolean
|
||||||
|
title: $exists
|
||||||
|
description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/Shell/store_product-types/get.sh
|
||||||
|
tags:
|
||||||
|
- Product Types
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../components/schemas/StoreProductTypeListResponse.yaml
|
||||||
|
'400':
|
||||||
|
$ref: ../components/responses/400_error.yaml
|
||||||
|
'401':
|
||||||
|
$ref: ../components/responses/unauthorized.yaml
|
||||||
|
'404':
|
||||||
|
$ref: ../components/responses/not_found_error.yaml
|
||||||
|
'409':
|
||||||
|
$ref: ../components/responses/invalid_state_error.yaml
|
||||||
|
'422':
|
||||||
|
$ref: ../components/responses/invalid_request_error.yaml
|
||||||
|
'500':
|
||||||
|
$ref: ../components/responses/500_error.yaml
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
get:
|
||||||
|
operationId: GetProductTypesId
|
||||||
|
summary: Get a Product Type
|
||||||
|
description: >-
|
||||||
|
Retrieve a product type by its ID. You can expand the product type's
|
||||||
|
relations or select the fields that should be returned.
|
||||||
|
x-authenticated: false
|
||||||
|
parameters:
|
||||||
|
- name: id
|
||||||
|
in: path
|
||||||
|
description: The product type's ID.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: x-publishable-api-key
|
||||||
|
in: header
|
||||||
|
description: Publishable API Key created in the Medusa Admin.
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
externalDocs:
|
||||||
|
url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
- name: fields
|
||||||
|
in: query
|
||||||
|
description: |-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
without prefix it will replace the entire default fields.
|
||||||
|
required: false
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
title: fields
|
||||||
|
description: >-
|
||||||
|
Comma-separated fields that should be included in the returned data.
|
||||||
|
If a field is prefixed with `+` it will be added to the default
|
||||||
|
fields, using `-` will remove it from the default fields. Without
|
||||||
|
prefix it will replace the entire default fields.
|
||||||
|
externalDocs:
|
||||||
|
url: '#select-fields-and-relations'
|
||||||
|
x-codeSamples:
|
||||||
|
- lang: Shell
|
||||||
|
label: cURL
|
||||||
|
source:
|
||||||
|
$ref: ../code_samples/Shell/store_product-types_{id}/get.sh
|
||||||
|
tags:
|
||||||
|
- Product Types
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: ../components/schemas/StoreProductTypeResponse.yaml
|
||||||
|
'400':
|
||||||
|
$ref: ../components/responses/400_error.yaml
|
||||||
|
'401':
|
||||||
|
$ref: ../components/responses/unauthorized.yaml
|
||||||
|
'404':
|
||||||
|
$ref: ../components/responses/not_found_error.yaml
|
||||||
|
'409':
|
||||||
|
$ref: ../components/responses/invalid_state_error.yaml
|
||||||
|
'422':
|
||||||
|
$ref: ../components/responses/invalid_request_error.yaml
|
||||||
|
'500':
|
||||||
|
$ref: ../components/responses/500_error.yaml
|
||||||
@@ -7,7 +7,7 @@ info:
|
|||||||
url: https://github.com/medusajs/medusa/blob/master/LICENSE
|
url: https://github.com/medusajs/medusa/blob/master/LICENSE
|
||||||
tags:
|
tags:
|
||||||
- name: Auth
|
- name: Auth
|
||||||
description: >
|
description: |
|
||||||
Auth API routes allow you to manage a customer's authentication.
|
Auth API routes allow you to manage a customer's authentication.
|
||||||
- name: Carts
|
- name: Carts
|
||||||
description: >
|
description: >
|
||||||
@@ -107,6 +107,10 @@ tags:
|
|||||||
url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
|
url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list
|
||||||
x-associatedSchema:
|
x-associatedSchema:
|
||||||
$ref: "#/components/schemas/StoreProductCategory"
|
$ref: "#/components/schemas/StoreProductCategory"
|
||||||
|
- name: Product Tags
|
||||||
|
x-associatedSchema:
|
||||||
|
$ref: "#/components/schemas/StoreProductTag"
|
||||||
|
- name: Product Types
|
||||||
- name: Products
|
- name: Products
|
||||||
description: >
|
description: >
|
||||||
Customers browse products for their purchase.
|
Customers browse products for their purchase.
|
||||||
|
|||||||
+7
-66
@@ -12,72 +12,7 @@
|
|||||||
* content:
|
* content:
|
||||||
* application/json:
|
* application/json:
|
||||||
* schema:
|
* schema:
|
||||||
* type: object
|
* $ref: "#/components/schemas/AdminBatchInventoryItemsLocationLevels"
|
||||||
* 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.
|
|
||||||
* x-codeSamples:
|
* x-codeSamples:
|
||||||
* - lang: Shell
|
* - lang: Shell
|
||||||
* label: cURL
|
* label: cURL
|
||||||
@@ -109,6 +44,12 @@
|
|||||||
* tags:
|
* tags:
|
||||||
* - Inventory Items
|
* - Inventory Items
|
||||||
* responses:
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/AdminBatchInventoryItemsLocationLevelsResponse"
|
||||||
* "400":
|
* "400":
|
||||||
* $ref: "#/components/responses/400_error"
|
* $ref: "#/components/responses/400_error"
|
||||||
* "401":
|
* "401":
|
||||||
|
|||||||
@@ -0,0 +1,607 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /store/product-tags
|
||||||
|
* operationId: GetProductTags
|
||||||
|
* summary: List Product Tags
|
||||||
|
* description: Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated.
|
||||||
|
* x-authenticated: false
|
||||||
|
* parameters:
|
||||||
|
* - name: x-publishable-api-key
|
||||||
|
* in: header
|
||||||
|
* description: Publishable API Key created in the Medusa Admin.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* externalDocs:
|
||||||
|
* url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
* - name: fields
|
||||||
|
* in: query
|
||||||
|
* description: |-
|
||||||
|
* Comma-separated fields that should be included in the returned data.
|
||||||
|
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* without prefix it will replace the entire default fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: fields
|
||||||
|
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||||
|
* fields. Without prefix it will replace the entire default fields.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#select-fields-and-relations"
|
||||||
|
* - name: offset
|
||||||
|
* in: query
|
||||||
|
* description: The number of items to skip when retrieving a list.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: number
|
||||||
|
* title: offset
|
||||||
|
* description: The number of items to skip when retrieving a list.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#pagination"
|
||||||
|
* - name: limit
|
||||||
|
* in: query
|
||||||
|
* description: Limit the number of items returned in the list.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: number
|
||||||
|
* title: limit
|
||||||
|
* description: Limit the number of items returned in the list.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#pagination"
|
||||||
|
* - name: order
|
||||||
|
* in: query
|
||||||
|
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: order
|
||||||
|
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#pagination"
|
||||||
|
* - name: $and
|
||||||
|
* in: query
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* - name: $or
|
||||||
|
* in: query
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* - name: q
|
||||||
|
* in: query
|
||||||
|
* description: Query to search product tag's searchable fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: q
|
||||||
|
* description: Query to search product tag's searchable fields.
|
||||||
|
* - name: id
|
||||||
|
* in: query
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: id
|
||||||
|
* description: Filter by a product tag's ID.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by product tag IDs.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: id
|
||||||
|
* description: A product tag's ID.
|
||||||
|
* - name: value
|
||||||
|
* in: query
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: value
|
||||||
|
* description: Filter by a product tag's value.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by product tag values.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: value
|
||||||
|
* description: A product tag's value.
|
||||||
|
* - name: created_at
|
||||||
|
* in: query
|
||||||
|
* description: Filter by the tag's creation date.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: object
|
||||||
|
* description: Filter by the tag's creation date.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: An exact match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not equal to this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value not to match.
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: The value to match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value to not match
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The value to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching those in this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The values to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* - name: updated_at
|
||||||
|
* in: query
|
||||||
|
* description: Filter by the tag's update date.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: object
|
||||||
|
* description: Filter by the tag's update date.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: An exact match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not equal to this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value not to match.
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: The value to match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value to not match
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The value to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching those in this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The values to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/store/product-tags' \
|
||||||
|
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
|
* tags:
|
||||||
|
* - Product Tags
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/StoreProductTagListResponse"
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /store/product-tags/{id}
|
||||||
|
* operationId: GetProductTagsId
|
||||||
|
* summary: Get a Product Tag
|
||||||
|
* description: Retrieve a product tag by its ID. You can expand the product tag's relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: false
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product tag's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: x-publishable-api-key
|
||||||
|
* in: header
|
||||||
|
* description: Publishable API Key created in the Medusa Admin.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* externalDocs:
|
||||||
|
* url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
* - name: fields
|
||||||
|
* in: query
|
||||||
|
* description: |-
|
||||||
|
* Comma-separated fields that should be included in the returned data.
|
||||||
|
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* without prefix it will replace the entire default fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: fields
|
||||||
|
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||||
|
* fields. Without prefix it will replace the entire default fields.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#select-fields-and-relations"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/store/product-tags/{id}' \
|
||||||
|
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
|
* tags:
|
||||||
|
* - Product Tags
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/StoreProductTagResponse"
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,607 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /store/product-types
|
||||||
|
* operationId: GetProductTypes
|
||||||
|
* summary: List Product Types
|
||||||
|
* description: Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated.
|
||||||
|
* x-authenticated: false
|
||||||
|
* parameters:
|
||||||
|
* - name: x-publishable-api-key
|
||||||
|
* in: header
|
||||||
|
* description: Publishable API Key created in the Medusa Admin.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* externalDocs:
|
||||||
|
* url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
* - name: fields
|
||||||
|
* in: query
|
||||||
|
* description: |-
|
||||||
|
* Comma-separated fields that should be included in the returned data.
|
||||||
|
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* without prefix it will replace the entire default fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: fields
|
||||||
|
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||||
|
* fields. Without prefix it will replace the entire default fields.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#select-fields-and-relations"
|
||||||
|
* - name: offset
|
||||||
|
* in: query
|
||||||
|
* description: The number of items to skip when retrieving a list.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: number
|
||||||
|
* title: offset
|
||||||
|
* description: The number of items to skip when retrieving a list.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#pagination"
|
||||||
|
* - name: limit
|
||||||
|
* in: query
|
||||||
|
* description: Limit the number of items returned in the list.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: number
|
||||||
|
* title: limit
|
||||||
|
* description: Limit the number of items returned in the list.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#pagination"
|
||||||
|
* - name: order
|
||||||
|
* in: query
|
||||||
|
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: order
|
||||||
|
* description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#pagination"
|
||||||
|
* - name: $and
|
||||||
|
* in: query
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* - name: $or
|
||||||
|
* in: query
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* - name: q
|
||||||
|
* in: query
|
||||||
|
* description: Query to search the product type's searchable fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: q
|
||||||
|
* description: Query to search the product type's searchable fields.
|
||||||
|
* - name: id
|
||||||
|
* in: query
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: id
|
||||||
|
* description: Filter by a product type's ID.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by product type IDs.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: id
|
||||||
|
* description: A product type's ID.
|
||||||
|
* - name: value
|
||||||
|
* in: query
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: value
|
||||||
|
* description: Filter by a product type's value.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by product type values.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: value
|
||||||
|
* description: A product type's value.
|
||||||
|
* - name: created_at
|
||||||
|
* in: query
|
||||||
|
* description: Filter by the type's creation date.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: object
|
||||||
|
* description: Filter by the type's creation date.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: An exact match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not equal to this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value not to match.
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: The value to match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value to not match
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The value to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching those in this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The values to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* - name: updated_at
|
||||||
|
* in: query
|
||||||
|
* description: Filter by the type's update date.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: object
|
||||||
|
* description: Filter by the type's update date.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: An exact match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not equal to this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value not to match.
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* properties:
|
||||||
|
* $and:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $and
|
||||||
|
* $or:
|
||||||
|
* type: array
|
||||||
|
* description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
|
||||||
|
* items:
|
||||||
|
* type: object
|
||||||
|
* title: $or
|
||||||
|
* $eq:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: Filter by an exact match.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by multiple exact matches.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $eq
|
||||||
|
* description: The value to match.
|
||||||
|
* $ne:
|
||||||
|
* type: string
|
||||||
|
* title: $ne
|
||||||
|
* description: Filter by values not matching this parameter.
|
||||||
|
* $in:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $in
|
||||||
|
* description: The value to match.
|
||||||
|
* $nin:
|
||||||
|
* type: array
|
||||||
|
* description: Filter by values not in this array.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $nin
|
||||||
|
* description: The value to not match
|
||||||
|
* $not:
|
||||||
|
* oneOf:
|
||||||
|
* - type: string
|
||||||
|
* title: $not
|
||||||
|
* description: Filter by values not matching this parameter
|
||||||
|
* - type: object
|
||||||
|
* description: Filter by values not matching the conditions in this parameter.
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The value to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* - type: array
|
||||||
|
* description: Filter by values not matching those in this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $not
|
||||||
|
* description: The values to not match.
|
||||||
|
* $gt:
|
||||||
|
* type: string
|
||||||
|
* title: $gt
|
||||||
|
* description: Filter by values greater than this parameter. Useful for numbers and dates only.
|
||||||
|
* $gte:
|
||||||
|
* type: string
|
||||||
|
* title: $gte
|
||||||
|
* description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $lt:
|
||||||
|
* type: string
|
||||||
|
* title: $lt
|
||||||
|
* description: Filter by values less than this parameter. Useful for numbers and dates only.
|
||||||
|
* $lte:
|
||||||
|
* type: string
|
||||||
|
* title: $lte
|
||||||
|
* description: Filter by values less than or equal to this parameter. Useful for numbers and dates only.
|
||||||
|
* $like:
|
||||||
|
* type: string
|
||||||
|
* title: $like
|
||||||
|
* description: Apply a `like` filter. Useful for strings only.
|
||||||
|
* $re:
|
||||||
|
* type: string
|
||||||
|
* title: $re
|
||||||
|
* description: Apply a regex filter. Useful for strings only.
|
||||||
|
* $ilike:
|
||||||
|
* type: string
|
||||||
|
* title: $ilike
|
||||||
|
* description: Apply a case-insensitive `like` filter. Useful for strings only.
|
||||||
|
* $fulltext:
|
||||||
|
* type: string
|
||||||
|
* title: $fulltext
|
||||||
|
* description: Filter to apply on full-text properties.
|
||||||
|
* $overlap:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that have overlapping values with this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $overlap
|
||||||
|
* description: The values to match.
|
||||||
|
* $contains:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain some of the values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contains
|
||||||
|
* description: The values to match.
|
||||||
|
* $contained:
|
||||||
|
* type: array
|
||||||
|
* description: Filter arrays that contain all values of this parameter.
|
||||||
|
* items:
|
||||||
|
* type: string
|
||||||
|
* title: $contained
|
||||||
|
* description: The values to match.
|
||||||
|
* $exists:
|
||||||
|
* type: boolean
|
||||||
|
* title: $exists
|
||||||
|
* description: Filter by whether a value for this parameter exists (not `null`).
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/store/product-types' \
|
||||||
|
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
|
* tags:
|
||||||
|
* - Product Types
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/StoreProductTypeListResponse"
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
/**
|
||||||
|
* @oas [get] /store/product-types/{id}
|
||||||
|
* operationId: GetProductTypesId
|
||||||
|
* summary: Get a Product Type
|
||||||
|
* description: Retrieve a product type by its ID. You can expand the product type's relations or select the fields that should be returned.
|
||||||
|
* x-authenticated: false
|
||||||
|
* parameters:
|
||||||
|
* - name: id
|
||||||
|
* in: path
|
||||||
|
* description: The product type's ID.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* - name: x-publishable-api-key
|
||||||
|
* in: header
|
||||||
|
* description: Publishable API Key created in the Medusa Admin.
|
||||||
|
* required: true
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* externalDocs:
|
||||||
|
* url: https://docs.medusajs.com/api/store#publishable-api-key
|
||||||
|
* - name: fields
|
||||||
|
* in: query
|
||||||
|
* description: |-
|
||||||
|
* Comma-separated fields that should be included in the returned data.
|
||||||
|
* if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields.
|
||||||
|
* without prefix it will replace the entire default fields.
|
||||||
|
* required: false
|
||||||
|
* schema:
|
||||||
|
* type: string
|
||||||
|
* title: fields
|
||||||
|
* description: Comma-separated fields that should be included in the returned data. If a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default
|
||||||
|
* fields. Without prefix it will replace the entire default fields.
|
||||||
|
* externalDocs:
|
||||||
|
* url: "#select-fields-and-relations"
|
||||||
|
* x-codeSamples:
|
||||||
|
* - lang: Shell
|
||||||
|
* label: cURL
|
||||||
|
* source: |-
|
||||||
|
* curl '{backend_url}/store/product-types/{id}' \
|
||||||
|
* -H 'x-publishable-api-key: {your_publishable_api_key}'
|
||||||
|
* tags:
|
||||||
|
* - Product Types
|
||||||
|
* responses:
|
||||||
|
* "200":
|
||||||
|
* description: OK
|
||||||
|
* content:
|
||||||
|
* application/json:
|
||||||
|
* schema:
|
||||||
|
* $ref: "#/components/schemas/StoreProductTypeResponse"
|
||||||
|
* "400":
|
||||||
|
* $ref: "#/components/responses/400_error"
|
||||||
|
* "401":
|
||||||
|
* $ref: "#/components/responses/unauthorized"
|
||||||
|
* "404":
|
||||||
|
* $ref: "#/components/responses/not_found_error"
|
||||||
|
* "409":
|
||||||
|
* $ref: "#/components/responses/invalid_state_error"
|
||||||
|
* "422":
|
||||||
|
* $ref: "#/components/responses/invalid_request_error"
|
||||||
|
* "500":
|
||||||
|
* $ref: "#/components/responses/500_error"
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
|
||||||
+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
|
* example: is_return
|
||||||
* operator:
|
* operator:
|
||||||
* type: string
|
* type: string
|
||||||
* title: operator
|
* description: The rule's operator.
|
||||||
* description: The shipping option rule's operator.
|
* enum:
|
||||||
* example: eq
|
* - gt
|
||||||
|
* - lt
|
||||||
|
* - eq
|
||||||
|
* - ne
|
||||||
|
* - in
|
||||||
|
* - lte
|
||||||
|
* - gte
|
||||||
|
* - nin
|
||||||
* value:
|
* value:
|
||||||
* type: string
|
* type: string
|
||||||
* title: value
|
* 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