chore(docs): Generated API Reference (#3262)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
67f9429293
commit
4fb22e8ba5
@@ -5,13 +5,32 @@ description: >-
|
||||
is given by the number of available Product Option combinations.
|
||||
type: object
|
||||
required:
|
||||
- title
|
||||
- product_id
|
||||
- allow_backorder
|
||||
- barcode
|
||||
- created_at
|
||||
- deleted_at
|
||||
- ean
|
||||
- height
|
||||
- hs_code
|
||||
- id
|
||||
- inventory_quantity
|
||||
- length
|
||||
- manage_inventory
|
||||
- material
|
||||
- metadata
|
||||
- mid_code
|
||||
- origin_country
|
||||
- product_id
|
||||
- sku
|
||||
- title
|
||||
- upc
|
||||
- updated_at
|
||||
- weight
|
||||
- width
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The product variant's ID
|
||||
type: string
|
||||
example: variant_01G1G5V2MRX2V3PVSR2WXYPFB6
|
||||
title:
|
||||
description: >-
|
||||
@@ -25,7 +44,8 @@ properties:
|
||||
example: prod_01G1G5V2MBA328390B5AXJ610F
|
||||
product:
|
||||
description: A product object. Available if the relation `product` is expanded.
|
||||
type: object
|
||||
nullable: true
|
||||
$ref: ./Product.yaml
|
||||
prices:
|
||||
description: >-
|
||||
The Money Amounts defined for the Product Variant. Each Money Amount
|
||||
@@ -39,24 +59,29 @@ properties:
|
||||
The unique stock keeping unit used to identify the Product Variant. This
|
||||
will usually be a unqiue identifer for the item that is to be shipped, and
|
||||
can be referenced across multiple systems.
|
||||
nullable: true
|
||||
type: string
|
||||
example: shirt-123
|
||||
barcode:
|
||||
description: >-
|
||||
A generic field for a GTIN number that can be used to identify the Product
|
||||
Variant.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
ean:
|
||||
description: An EAN barcode number that can be used to identify the Product Variant.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
upc:
|
||||
description: A UPC barcode number that can be used to identify the Product Variant.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
variant_rank:
|
||||
description: The ranking of this variant
|
||||
nullable: true
|
||||
type: number
|
||||
default: 0
|
||||
inventory_quantity:
|
||||
@@ -77,12 +102,14 @@ properties:
|
||||
description: >-
|
||||
The Harmonized System code of the Product Variant. May be used by
|
||||
Fulfillment Providers to pass customs information to shipping carriers.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
origin_country:
|
||||
description: >-
|
||||
The country in which the Product Variant was produced. May be used by
|
||||
Fulfillment Providers to pass customs information to shipping carriers.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
mid_code:
|
||||
@@ -90,6 +117,7 @@ properties:
|
||||
The Manufacturers Identification code that identifies the manufacturer of
|
||||
the Product Variant. May be used by Fulfillment Providers to pass customs
|
||||
information to shipping carriers.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
material:
|
||||
@@ -97,30 +125,35 @@ properties:
|
||||
The material and composition that the Product Variant is made of, May be
|
||||
used by Fulfillment Providers to pass customs information to shipping
|
||||
carriers.
|
||||
nullable: true
|
||||
type: string
|
||||
example: null
|
||||
weight:
|
||||
description: >-
|
||||
The weight of the Product Variant. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
example: null
|
||||
height:
|
||||
description: >-
|
||||
The height of the Product Variant. May be used in shipping rate
|
||||
calculations.
|
||||
type: number
|
||||
example: null
|
||||
width:
|
||||
description: >-
|
||||
The width of the Product Variant. May be used in shipping rate
|
||||
calculations.
|
||||
nullable: true
|
||||
type: number
|
||||
example: null
|
||||
length:
|
||||
description: >-
|
||||
The length of the Product Variant. May be used in shipping rate
|
||||
calculations.
|
||||
nullable: true
|
||||
type: number
|
||||
example: null
|
||||
height:
|
||||
description: >-
|
||||
The height of the Product Variant. May be used in shipping rate
|
||||
calculations.
|
||||
nullable: true
|
||||
type: number
|
||||
example: null
|
||||
width:
|
||||
description: >-
|
||||
The width of the Product Variant. May be used in shipping rate
|
||||
calculations.
|
||||
nullable: true
|
||||
type: number
|
||||
example: null
|
||||
options:
|
||||
@@ -130,20 +163,29 @@ properties:
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ProductOptionValue.yaml
|
||||
inventory_items:
|
||||
description: >-
|
||||
The Inventory Items related to the product variant. Available if the
|
||||
relation `inventory_items` is expanded.
|
||||
type: array
|
||||
items:
|
||||
$ref: ./ProductVariantInventoryItem.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user