fa7c94b4cc
* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
165 lines
4.9 KiB
YAML
165 lines
4.9 KiB
YAML
get:
|
|
operationId: GetVariants
|
|
summary: List Product Variants
|
|
description: >-
|
|
Retrieve a list of Product Variants. The product variant can be filtered by
|
|
fields such as `id` or `title`. The product variant can also be paginated.
|
|
x-authenticated: true
|
|
parameters:
|
|
- in: query
|
|
name: id
|
|
style: form
|
|
explode: false
|
|
description: Filter by product variant IDs.
|
|
schema:
|
|
oneOf:
|
|
- type: string
|
|
description: A product variant ID.
|
|
- type: array
|
|
description: An array of product variant IDs.
|
|
items:
|
|
type: string
|
|
- in: query
|
|
name: expand
|
|
description: >-
|
|
"Comma-separated relations that should be expanded in the returned
|
|
product variants."
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: fields
|
|
description: >-
|
|
"Comma-separated fields that should be included in the returned product
|
|
variants."
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: offset
|
|
description: >-
|
|
The number of product variants to skip when retrieving the product
|
|
variants.
|
|
schema:
|
|
type: number
|
|
default: '0'
|
|
- in: query
|
|
name: limit
|
|
description: Limit the number of product variants returned.
|
|
schema:
|
|
type: number
|
|
default: '100'
|
|
- in: query
|
|
name: cart_id
|
|
style: form
|
|
explode: false
|
|
description: The ID of the cart to use for the price selection context.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: region_id
|
|
style: form
|
|
explode: false
|
|
description: The ID of the region to use for the price selection context.
|
|
schema:
|
|
type: string
|
|
externalDocs:
|
|
description: Price selection context overview
|
|
url: >-
|
|
https://docs.medusajs.com/modules/price-lists/price-selection-strategy#context-object
|
|
- in: query
|
|
name: currency_code
|
|
style: form
|
|
explode: false
|
|
description: >-
|
|
The 3 character ISO currency code to use for the price selection
|
|
context.
|
|
schema:
|
|
type: string
|
|
externalDocs:
|
|
description: Price selection context overview
|
|
url: >-
|
|
https://docs.medusajs.com/modules/price-lists/price-selection-strategy#context-object
|
|
- in: query
|
|
name: customer_id
|
|
style: form
|
|
explode: false
|
|
description: The ID of the customer to use for the price selection context.
|
|
schema:
|
|
type: string
|
|
externalDocs:
|
|
description: Price selection context overview
|
|
url: >-
|
|
https://docs.medusajs.com/modules/price-lists/price-selection-strategy#context-object
|
|
- in: query
|
|
name: title
|
|
style: form
|
|
explode: false
|
|
description: Filter by title.
|
|
schema:
|
|
oneOf:
|
|
- type: string
|
|
description: a single title to filter by
|
|
- type: array
|
|
description: multiple titles to filter by
|
|
items:
|
|
type: string
|
|
- in: query
|
|
name: inventory_quantity
|
|
description: Filter by available inventory quantity
|
|
schema:
|
|
oneOf:
|
|
- type: number
|
|
description: a specific number to filter by.
|
|
- type: object
|
|
description: filter using less and greater than comparisons.
|
|
properties:
|
|
lt:
|
|
type: number
|
|
description: filter by inventory quantity less than this number
|
|
gt:
|
|
type: number
|
|
description: filter by inventory quantity greater than this number
|
|
lte:
|
|
type: number
|
|
description: filter by inventory quantity less than or equal to this number
|
|
gte:
|
|
type: number
|
|
description: >-
|
|
filter by inventory quantity greater than or equal to this
|
|
number
|
|
x-codegen:
|
|
method: list
|
|
queryParams: AdminGetVariantsParams
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: ../code_samples/JavaScript/admin_variants/get.js
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/admin_variants/get.sh
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- Product Variants
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: ../components/schemas/AdminVariantsListRes.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
|