60 lines
1.7 KiB
YAML
60 lines
1.7 KiB
YAML
get:
|
|
operationId: GetVariantsVariant
|
|
summary: Get a Product Variant
|
|
description: Retrieves a Product Variant by id
|
|
parameters:
|
|
- in: path
|
|
name: variant_id
|
|
required: true
|
|
description: The id of the Product Variant.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: cart_id
|
|
description: The id of the Cart to set prices based on.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: region_id
|
|
description: The id of the Region to set prices based on.
|
|
schema:
|
|
type: string
|
|
- in: query
|
|
name: currency_code
|
|
style: form
|
|
explode: false
|
|
description: The 3 character ISO currency code to set prices based on.
|
|
schema:
|
|
type: string
|
|
externalDocs:
|
|
url: https://en.wikipedia.org/wiki/ISO_4217#Active_codes
|
|
description: See a list of codes.
|
|
x-codeSamples:
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: ../code_samples/Shell/variants_{variant_id}/getundefined
|
|
tags:
|
|
- Product Variant
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
variant:
|
|
allOf:
|
|
- $ref: ../components/schemas/product_variant.yaml
|
|
- $ref: ../components/schemas/product_variant_prices_fields.yaml
|
|
'400':
|
|
$ref: ../components/responses/400_error.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
|