chore(docs): Generated API Reference (v2) (#8053)
Co-authored-by: kodiakhq <kodiakhq@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
committed by
GitHub
GitHub
parent
964f1f9dbe
commit
7fa04aabce
@@ -21,3 +21,6 @@ properties:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
|
||||
@@ -93,6 +93,10 @@ properties:
|
||||
type: number
|
||||
title: width
|
||||
description: The updated's width.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
options:
|
||||
type: array
|
||||
description: The updated's options.
|
||||
@@ -104,10 +108,8 @@ properties:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The updated's product id.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
calculated_price:
|
||||
$ref: ./BaseCalculatedPriceSet.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
|
||||
@@ -2,7 +2,6 @@ type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateStore
|
||||
required:
|
||||
- name
|
||||
- default_sales_channel_id
|
||||
- default_region_id
|
||||
- default_location_id
|
||||
@@ -29,6 +28,10 @@ properties:
|
||||
type: boolean
|
||||
title: is_default
|
||||
description: The supported currency's is default.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The supported currency's is tax inclusive.
|
||||
default_sales_channel_id:
|
||||
type: string
|
||||
title: default_sales_channel_id
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
type: object
|
||||
description: The updated's calculated price.
|
||||
x-schemaName: BaseCalculatedPriceSet
|
||||
required:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The calculated price's ID.
|
||||
is_calculated_price_price_list:
|
||||
type: boolean
|
||||
title: is_calculated_price_price_list
|
||||
description: The calculated price's is calculated price price list.
|
||||
is_calculated_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_calculated_price_tax_inclusive
|
||||
description: The calculated price's is calculated price tax inclusive.
|
||||
calculated_amount:
|
||||
type: number
|
||||
title: calculated_amount
|
||||
description: The calculated price's calculated amount.
|
||||
calculated_amount_with_tax:
|
||||
type: number
|
||||
title: calculated_amount_with_tax
|
||||
description: The calculated price's calculated amount with tax.
|
||||
calculated_amount_without_tax:
|
||||
type: number
|
||||
title: calculated_amount_without_tax
|
||||
description: The calculated price's calculated amount without tax.
|
||||
is_original_price_price_list:
|
||||
type: boolean
|
||||
title: is_original_price_price_list
|
||||
description: The calculated price's is original price price list.
|
||||
is_original_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_original_price_tax_inclusive
|
||||
description: The calculated price's is original price tax inclusive.
|
||||
original_amount:
|
||||
type: number
|
||||
title: original_amount
|
||||
description: The calculated price's original amount.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The calculated price's currency code.
|
||||
calculated_price:
|
||||
type: object
|
||||
description: The calculated price's details.
|
||||
original_price:
|
||||
type: object
|
||||
description: The calculated price's original price.
|
||||
@@ -30405,6 +30405,10 @@ paths:
|
||||
metadata:
|
||||
type: object
|
||||
description: The region's metadata.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The region's is tax inclusive.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -30604,6 +30608,10 @@ paths:
|
||||
metadata:
|
||||
type: object
|
||||
description: The region's metadata.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The region's is tax inclusive.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
@@ -39269,6 +39277,9 @@ components:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
AdminCreateSalesChannel:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -40550,6 +40561,10 @@ components:
|
||||
type: number
|
||||
title: width
|
||||
description: The updated's width.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
options:
|
||||
type: array
|
||||
description: The updated's options.
|
||||
@@ -40561,10 +40576,8 @@ components:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The updated's product id.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
calculated_price:
|
||||
$ref: '#/components/schemas/BaseCalculatedPriceSet'
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -41610,7 +41623,6 @@ components:
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateStore
|
||||
required:
|
||||
- name
|
||||
- default_sales_channel_id
|
||||
- default_region_id
|
||||
- default_location_id
|
||||
@@ -41637,6 +41649,10 @@ components:
|
||||
type: boolean
|
||||
title: is_default
|
||||
description: The supported currency's is default.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The supported currency's is tax inclusive.
|
||||
default_sales_channel_id:
|
||||
type: string
|
||||
title: default_sales_channel_id
|
||||
@@ -41732,6 +41748,62 @@ components:
|
||||
type: number
|
||||
title: required_quantity
|
||||
description: The product's required quantity.
|
||||
BaseCalculatedPriceSet:
|
||||
type: object
|
||||
description: The updated's calculated price.
|
||||
x-schemaName: BaseCalculatedPriceSet
|
||||
required:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The calculated price's ID.
|
||||
is_calculated_price_price_list:
|
||||
type: boolean
|
||||
title: is_calculated_price_price_list
|
||||
description: The calculated price's is calculated price price list.
|
||||
is_calculated_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_calculated_price_tax_inclusive
|
||||
description: The calculated price's is calculated price tax inclusive.
|
||||
calculated_amount:
|
||||
type: number
|
||||
title: calculated_amount
|
||||
description: The calculated price's calculated amount.
|
||||
calculated_amount_with_tax:
|
||||
type: number
|
||||
title: calculated_amount_with_tax
|
||||
description: The calculated price's calculated amount with tax.
|
||||
calculated_amount_without_tax:
|
||||
type: number
|
||||
title: calculated_amount_without_tax
|
||||
description: The calculated price's calculated amount without tax.
|
||||
is_original_price_price_list:
|
||||
type: boolean
|
||||
title: is_original_price_price_list
|
||||
description: The calculated price's is original price price list.
|
||||
is_original_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_original_price_tax_inclusive
|
||||
description: The calculated price's is original price tax inclusive.
|
||||
original_amount:
|
||||
type: number
|
||||
title: original_amount
|
||||
description: The calculated price's original amount.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The calculated price's currency code.
|
||||
calculated_price:
|
||||
type: object
|
||||
description: The calculated price's details.
|
||||
original_price:
|
||||
type: object
|
||||
description: The calculated price's original price.
|
||||
BaseCollection:
|
||||
type: object
|
||||
description: The product's collection.
|
||||
|
||||
@@ -347,6 +347,10 @@ post:
|
||||
metadata:
|
||||
type: object
|
||||
description: The region's metadata.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The region's is tax inclusive.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
@@ -200,6 +200,10 @@ post:
|
||||
metadata:
|
||||
type: object
|
||||
description: The region's metadata.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The region's is tax inclusive.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
curl '{backend_url}/store/products'
|
||||
@@ -1 +0,0 @@
|
||||
curl '{backend_url}/store/products/{id}'
|
||||
@@ -21,3 +21,6 @@ properties:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
|
||||
@@ -93,6 +93,10 @@ properties:
|
||||
type: number
|
||||
title: width
|
||||
description: The updated's width.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
options:
|
||||
type: array
|
||||
description: The updated's options.
|
||||
@@ -104,10 +108,8 @@ properties:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The updated's product id.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
calculated_price:
|
||||
$ref: ./BaseCalculatedPriceSet.yaml
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
|
||||
@@ -2,7 +2,6 @@ type: object
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateStore
|
||||
required:
|
||||
- name
|
||||
- default_sales_channel_id
|
||||
- default_region_id
|
||||
- default_location_id
|
||||
@@ -29,6 +28,10 @@ properties:
|
||||
type: boolean
|
||||
title: is_default
|
||||
description: The supported currency's is default.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The supported currency's is tax inclusive.
|
||||
default_sales_channel_id:
|
||||
type: string
|
||||
title: default_sales_channel_id
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
type: object
|
||||
description: The updated's calculated price.
|
||||
x-schemaName: BaseCalculatedPriceSet
|
||||
required:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The calculated price's ID.
|
||||
is_calculated_price_price_list:
|
||||
type: boolean
|
||||
title: is_calculated_price_price_list
|
||||
description: The calculated price's is calculated price price list.
|
||||
is_calculated_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_calculated_price_tax_inclusive
|
||||
description: The calculated price's is calculated price tax inclusive.
|
||||
calculated_amount:
|
||||
type: number
|
||||
title: calculated_amount
|
||||
description: The calculated price's calculated amount.
|
||||
calculated_amount_with_tax:
|
||||
type: number
|
||||
title: calculated_amount_with_tax
|
||||
description: The calculated price's calculated amount with tax.
|
||||
calculated_amount_without_tax:
|
||||
type: number
|
||||
title: calculated_amount_without_tax
|
||||
description: The calculated price's calculated amount without tax.
|
||||
is_original_price_price_list:
|
||||
type: boolean
|
||||
title: is_original_price_price_list
|
||||
description: The calculated price's is original price price list.
|
||||
is_original_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_original_price_tax_inclusive
|
||||
description: The calculated price's is original price tax inclusive.
|
||||
original_amount:
|
||||
type: number
|
||||
title: original_amount
|
||||
description: The calculated price's original amount.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The calculated price's currency code.
|
||||
calculated_price:
|
||||
type: object
|
||||
description: The calculated price's details.
|
||||
original_price:
|
||||
type: object
|
||||
description: The calculated price's original price.
|
||||
@@ -27,9 +27,6 @@ tags:
|
||||
- name: Product Categories
|
||||
x-associatedSchema:
|
||||
$ref: '#/components/schemas/StoreProductCategory'
|
||||
- name: Products
|
||||
x-associatedSchema:
|
||||
$ref: '#/components/schemas/StoreProduct'
|
||||
- name: Regions
|
||||
description: |
|
||||
Regions are different countries or geographical regions that the commerce store serves customers in.
|
||||
@@ -2991,662 +2988,6 @@ paths:
|
||||
$ref: '#/components/responses/invalid_request_error'
|
||||
'500':
|
||||
$ref: '#/components/responses/500_error'
|
||||
/store/products:
|
||||
get:
|
||||
operationId: GetProducts
|
||||
summary: List Products
|
||||
description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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 `-`.
|
||||
- name: currency_code
|
||||
in: query
|
||||
description: The product's currency code.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The product's currency code.
|
||||
- name: region_id
|
||||
in: query
|
||||
description: The product's region id.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The product's region id.
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: variants
|
||||
in: query
|
||||
description: The product's variants.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's variants.
|
||||
properties:
|
||||
status:
|
||||
type: array
|
||||
description: The variant's status.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
options:
|
||||
type: object
|
||||
description: The variant's options.
|
||||
required:
|
||||
- value
|
||||
- option_id
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
$and: {}
|
||||
$or: {}
|
||||
- name: q
|
||||
in: query
|
||||
description: The product's q.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The product's q.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
- type: array
|
||||
description: The product's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
- name: title
|
||||
in: query
|
||||
description: The product's title.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
- name: handle
|
||||
in: query
|
||||
description: The product's handle.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
- name: is_giftcard
|
||||
in: query
|
||||
description: The product's is giftcard.
|
||||
required: true
|
||||
schema:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
- name: category_id
|
||||
in: query
|
||||
description: The product's category id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's category id.
|
||||
items:
|
||||
type: string
|
||||
title: category_id
|
||||
description: The category id's details.
|
||||
- name: sales_channel_id
|
||||
in: query
|
||||
description: The product's sales channel id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
- name: collection_id
|
||||
in: query
|
||||
description: The product's collection id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
- name: tags
|
||||
in: query
|
||||
description: The product's tags.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
- name: type_id
|
||||
in: query
|
||||
description: The product's type id.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The product's created at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's created at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The product's updated at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's updated at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The product's deleted at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's deleted at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source: curl '{backend_url}/store/products'
|
||||
tags:
|
||||
- Products
|
||||
responses:
|
||||
'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'
|
||||
/store/products/{id}:
|
||||
get:
|
||||
operationId: GetProductsId
|
||||
summary: Get a Product
|
||||
description: Retrieve a product by its ID. You can expand the product's relations or select the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The product's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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 `-`.
|
||||
- name: currency_code
|
||||
in: query
|
||||
description: The product's currency code.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The product's currency code.
|
||||
- name: region_id
|
||||
in: query
|
||||
description: The product's region id.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The product's region id.
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: variants
|
||||
in: query
|
||||
description: The product's variants.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's variants.
|
||||
properties:
|
||||
status:
|
||||
type: array
|
||||
description: The variant's status.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
options:
|
||||
type: object
|
||||
description: The variant's options.
|
||||
required:
|
||||
- value
|
||||
- option_id
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
$and: {}
|
||||
$or: {}
|
||||
- name: q
|
||||
in: query
|
||||
description: The product's q.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The product's q.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
- type: array
|
||||
description: The product's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
- name: title
|
||||
in: query
|
||||
description: The product's title.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
- name: handle
|
||||
in: query
|
||||
description: The product's handle.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
- name: is_giftcard
|
||||
in: query
|
||||
description: The product's is giftcard.
|
||||
required: true
|
||||
schema:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
- name: category_id
|
||||
in: query
|
||||
description: The product's category id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's category id.
|
||||
items:
|
||||
type: string
|
||||
title: category_id
|
||||
description: The category id's details.
|
||||
- name: sales_channel_id
|
||||
in: query
|
||||
description: The product's sales channel id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
- name: collection_id
|
||||
in: query
|
||||
description: The product's collection id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
- name: tags
|
||||
in: query
|
||||
description: The product's tags.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
- name: type_id
|
||||
in: query
|
||||
description: The product's type id.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The product's created at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's created at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The product's updated at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's updated at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The product's deleted at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's deleted at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source: curl '{backend_url}/store/products/{id}'
|
||||
tags:
|
||||
- Products
|
||||
responses:
|
||||
'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'
|
||||
/store/regions:
|
||||
get:
|
||||
operationId: GetRegions
|
||||
@@ -5155,6 +4496,9 @@ components:
|
||||
type: number
|
||||
title: max_quantity
|
||||
description: The price's max quantity.
|
||||
rules:
|
||||
type: object
|
||||
description: The price's rules.
|
||||
AdminCreateSalesChannel:
|
||||
type: object
|
||||
description: SUMMARY
|
||||
@@ -6436,6 +5780,10 @@ components:
|
||||
type: number
|
||||
title: width
|
||||
description: The updated's width.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
options:
|
||||
type: array
|
||||
description: The updated's options.
|
||||
@@ -6447,10 +5795,8 @@ components:
|
||||
type: string
|
||||
title: product_id
|
||||
description: The updated's product id.
|
||||
variant_rank:
|
||||
type: number
|
||||
title: variant_rank
|
||||
description: The updated's variant rank.
|
||||
calculated_price:
|
||||
$ref: '#/components/schemas/BaseCalculatedPriceSet'
|
||||
created_at:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -7496,7 +6842,6 @@ components:
|
||||
description: SUMMARY
|
||||
x-schemaName: AdminUpdateStore
|
||||
required:
|
||||
- name
|
||||
- default_sales_channel_id
|
||||
- default_region_id
|
||||
- default_location_id
|
||||
@@ -7523,6 +6868,10 @@ components:
|
||||
type: boolean
|
||||
title: is_default
|
||||
description: The supported currency's is default.
|
||||
is_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_tax_inclusive
|
||||
description: The supported currency's is tax inclusive.
|
||||
default_sales_channel_id:
|
||||
type: string
|
||||
title: default_sales_channel_id
|
||||
@@ -7618,6 +6967,62 @@ components:
|
||||
type: number
|
||||
title: required_quantity
|
||||
description: The product's required quantity.
|
||||
BaseCalculatedPriceSet:
|
||||
type: object
|
||||
description: The updated's calculated price.
|
||||
x-schemaName: BaseCalculatedPriceSet
|
||||
required:
|
||||
- id
|
||||
- calculated_amount
|
||||
- original_amount
|
||||
- currency_code
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
title: id
|
||||
description: The calculated price's ID.
|
||||
is_calculated_price_price_list:
|
||||
type: boolean
|
||||
title: is_calculated_price_price_list
|
||||
description: The calculated price's is calculated price price list.
|
||||
is_calculated_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_calculated_price_tax_inclusive
|
||||
description: The calculated price's is calculated price tax inclusive.
|
||||
calculated_amount:
|
||||
type: number
|
||||
title: calculated_amount
|
||||
description: The calculated price's calculated amount.
|
||||
calculated_amount_with_tax:
|
||||
type: number
|
||||
title: calculated_amount_with_tax
|
||||
description: The calculated price's calculated amount with tax.
|
||||
calculated_amount_without_tax:
|
||||
type: number
|
||||
title: calculated_amount_without_tax
|
||||
description: The calculated price's calculated amount without tax.
|
||||
is_original_price_price_list:
|
||||
type: boolean
|
||||
title: is_original_price_price_list
|
||||
description: The calculated price's is original price price list.
|
||||
is_original_price_tax_inclusive:
|
||||
type: boolean
|
||||
title: is_original_price_tax_inclusive
|
||||
description: The calculated price's is original price tax inclusive.
|
||||
original_amount:
|
||||
type: number
|
||||
title: original_amount
|
||||
description: The calculated price's original amount.
|
||||
currency_code:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The calculated price's currency code.
|
||||
calculated_price:
|
||||
type: object
|
||||
description: The calculated price's details.
|
||||
original_price:
|
||||
type: object
|
||||
description: The calculated price's original price.
|
||||
BaseCollection:
|
||||
type: object
|
||||
description: The product's collection.
|
||||
|
||||
@@ -31,9 +31,6 @@ tags:
|
||||
- name: Product Categories
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/StoreProductCategory.yaml
|
||||
- name: Products
|
||||
x-associatedSchema:
|
||||
$ref: ./components/schemas/StoreProduct.yaml
|
||||
- name: Regions
|
||||
description: >
|
||||
Regions are different countries or geographical regions that the commerce
|
||||
@@ -95,10 +92,6 @@ paths:
|
||||
$ref: paths/store_product-categories.yaml
|
||||
/store/product-categories/{id}:
|
||||
$ref: paths/store_product-categories_{id}.yaml
|
||||
/store/products:
|
||||
$ref: paths/store_products.yaml
|
||||
/store/products/{id}:
|
||||
$ref: paths/store_products_{id}.yaml
|
||||
/store/regions:
|
||||
$ref: paths/store_regions.yaml
|
||||
/store/regions/{id}:
|
||||
|
||||
@@ -1,342 +0,0 @@
|
||||
get:
|
||||
operationId: GetProducts
|
||||
summary: List Products
|
||||
description: >-
|
||||
Retrieve a list of products. The products can be filtered by fields such as
|
||||
`id`. The products can also be sorted or paginated.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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 `-`.
|
||||
- name: currency_code
|
||||
in: query
|
||||
description: The product's currency code.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The product's currency code.
|
||||
- name: region_id
|
||||
in: query
|
||||
description: The product's region id.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The product's region id.
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: variants
|
||||
in: query
|
||||
description: The product's variants.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's variants.
|
||||
properties:
|
||||
status:
|
||||
type: array
|
||||
description: The variant's status.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
options:
|
||||
type: object
|
||||
description: The variant's options.
|
||||
required:
|
||||
- value
|
||||
- option_id
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
$and: {}
|
||||
$or: {}
|
||||
- name: q
|
||||
in: query
|
||||
description: The product's q.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The product's q.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
- type: array
|
||||
description: The product's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
- name: title
|
||||
in: query
|
||||
description: The product's title.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
- name: handle
|
||||
in: query
|
||||
description: The product's handle.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
- name: is_giftcard
|
||||
in: query
|
||||
description: The product's is giftcard.
|
||||
required: true
|
||||
schema:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
- name: category_id
|
||||
in: query
|
||||
description: The product's category id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's category id.
|
||||
items:
|
||||
type: string
|
||||
title: category_id
|
||||
description: The category id's details.
|
||||
- name: sales_channel_id
|
||||
in: query
|
||||
description: The product's sales channel id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
- name: collection_id
|
||||
in: query
|
||||
description: The product's collection id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
- name: tags
|
||||
in: query
|
||||
description: The product's tags.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
- name: type_id
|
||||
in: query
|
||||
description: The product's type id.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The product's created at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's created at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The product's updated at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's updated at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The product's deleted at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's deleted at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_products/get.sh
|
||||
tags:
|
||||
- Products
|
||||
responses:
|
||||
'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
|
||||
@@ -1,348 +0,0 @@
|
||||
get:
|
||||
operationId: GetProductsId
|
||||
summary: Get a Product
|
||||
description: >-
|
||||
Retrieve a product by its ID. You can expand the product's relations or
|
||||
select the fields that should be returned.
|
||||
x-authenticated: false
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: The product's ID.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
- name: expand
|
||||
in: query
|
||||
description: Comma-separated relations that should be expanded in the returned data.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: expand
|
||||
description: >-
|
||||
Comma-separated relations that should be expanded in the returned
|
||||
data.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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.
|
||||
- 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 `-`.
|
||||
- name: currency_code
|
||||
in: query
|
||||
description: The product's currency code.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: currency_code
|
||||
description: The product's currency code.
|
||||
- name: region_id
|
||||
in: query
|
||||
description: The product's region id.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: region_id
|
||||
description: The product's region id.
|
||||
- name: $and
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: $or
|
||||
in: query
|
||||
required: false
|
||||
schema: {}
|
||||
- name: variants
|
||||
in: query
|
||||
description: The product's variants.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's variants.
|
||||
properties:
|
||||
status:
|
||||
type: array
|
||||
description: The variant's status.
|
||||
items:
|
||||
type: string
|
||||
enum:
|
||||
- draft
|
||||
- proposed
|
||||
- published
|
||||
- rejected
|
||||
options:
|
||||
type: object
|
||||
description: The variant's options.
|
||||
required:
|
||||
- value
|
||||
- option_id
|
||||
properties:
|
||||
value:
|
||||
type: string
|
||||
title: value
|
||||
description: The option's value.
|
||||
option_id:
|
||||
type: string
|
||||
title: option_id
|
||||
description: The option's option id.
|
||||
$and: {}
|
||||
$or: {}
|
||||
- name: q
|
||||
in: query
|
||||
description: The product's q.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: q
|
||||
description: The product's q.
|
||||
- name: id
|
||||
in: query
|
||||
required: false
|
||||
schema:
|
||||
oneOf:
|
||||
- type: string
|
||||
title: id
|
||||
description: The product's ID.
|
||||
- type: array
|
||||
description: The product's ID.
|
||||
items:
|
||||
type: string
|
||||
title: id
|
||||
description: The id's ID.
|
||||
- name: title
|
||||
in: query
|
||||
description: The product's title.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: title
|
||||
description: The product's title.
|
||||
- name: handle
|
||||
in: query
|
||||
description: The product's handle.
|
||||
required: true
|
||||
schema:
|
||||
type: string
|
||||
title: handle
|
||||
description: The product's handle.
|
||||
- name: is_giftcard
|
||||
in: query
|
||||
description: The product's is giftcard.
|
||||
required: true
|
||||
schema:
|
||||
type: boolean
|
||||
title: is_giftcard
|
||||
description: The product's is giftcard.
|
||||
- name: category_id
|
||||
in: query
|
||||
description: The product's category id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's category id.
|
||||
items:
|
||||
type: string
|
||||
title: category_id
|
||||
description: The category id's details.
|
||||
- name: sales_channel_id
|
||||
in: query
|
||||
description: The product's sales channel id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's sales channel id.
|
||||
items:
|
||||
type: string
|
||||
title: sales_channel_id
|
||||
description: The sales channel id's details.
|
||||
- name: collection_id
|
||||
in: query
|
||||
description: The product's collection id.
|
||||
required: true
|
||||
schema:
|
||||
type: array
|
||||
description: The product's collection id.
|
||||
items:
|
||||
type: string
|
||||
title: collection_id
|
||||
description: The collection id's details.
|
||||
- name: tags
|
||||
in: query
|
||||
description: The product's tags.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's tags.
|
||||
items:
|
||||
type: string
|
||||
title: tags
|
||||
description: The tag's tags.
|
||||
- name: type_id
|
||||
in: query
|
||||
description: The product's type id.
|
||||
required: false
|
||||
schema:
|
||||
type: array
|
||||
description: The product's type id.
|
||||
items:
|
||||
type: string
|
||||
title: type_id
|
||||
description: The type id's details.
|
||||
- name: created_at
|
||||
in: query
|
||||
description: The product's created at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's created at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: updated_at
|
||||
in: query
|
||||
description: The product's updated at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's updated at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
- name: deleted_at
|
||||
in: query
|
||||
description: The product's deleted at.
|
||||
required: false
|
||||
schema:
|
||||
type: object
|
||||
description: The product's deleted at.
|
||||
required:
|
||||
- $eq
|
||||
- $ne
|
||||
- $in
|
||||
- $nin
|
||||
- $like
|
||||
- $ilike
|
||||
- $re
|
||||
- $contains
|
||||
- $gt
|
||||
- $gte
|
||||
- $lt
|
||||
- $lte
|
||||
properties:
|
||||
$eq: {}
|
||||
$ne: {}
|
||||
$in: {}
|
||||
$nin: {}
|
||||
$like: {}
|
||||
$ilike: {}
|
||||
$re: {}
|
||||
$contains: {}
|
||||
$gt: {}
|
||||
$gte: {}
|
||||
$lt: {}
|
||||
$lte: {}
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
source:
|
||||
$ref: ../code_samples/Shell/store_products_{id}/get.sh
|
||||
tags:
|
||||
- Products
|
||||
responses:
|
||||
'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
|
||||
Reference in New Issue
Block a user