Pular para o conteúdo
Olist Ecommerce

Lista as variantes

GET
/api/v2/products/{product_id}/variants

Permite listar as variantes de um produto

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

Seção intitulada “Path Parameters ”
product_id
required
string

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Quando as variantes são listadas

Array<object>
Variant

Modelo que representa uma variante na API

object
id
integer
main
boolean
available
boolean
sku
string
name
string
slug
string
min_quantity
integer
quantity

Quantidade física

integer
quantity_sold
integer
stock

Quantidade disponível

integer
custom_attributes
object
properties
object
property1
variant_property

Modelo que representa uma propriedade customizada na API

object
defining
required
boolean
name
required
string
value
string
property2
variant_property

Modelo que representa uma propriedade customizada na API

object
defining
required
boolean
name
required
string
value
string
property3
variant_property

Modelo que representa uma propriedade customizada na API

object
defining
required
boolean
name
required
string
value
string
updated_at
string format: date-time
price
number
installments
Array<number>
available_quantity
integer
weight
number
width
number
height
number
length
number
handling_days
integer
inventories
Array<object>

Model que representa um inventory da variante

object
id
required
integer
>= 1
name
required
string
>= 1 characters
place_id
required
integer
price
required
number
quantity
required
integer
quantity_sold
required
integer
sale_price
required
number
slug
required
string
sale_price
number
intl_price
number
image_url
string
product_id
integer
barcode
string
nullable
norder
integer
Examples
[
  {
    "id": 95,
    "main": true,
    "available": true,
    "sku": "123",
    "name": "Variation",
    "slug": "variation",
    "min_quantity": 1,
    "quantity": 1,
    "quantity_sold": 0,
    "stock": 1,
    "custom_attributes": {},
    "properties": {},
    "updated_at": "2020-10-27T11:54:32.018-03:00",
    "price": 10,
    "installments": [
      10
    ],
    "available_quantity": 1,
    "weight": 0.001,
    "width": 1,
    "height": 1,
    "length": 1,
    "handling_days": 0,
    "inventories": [],
    "sale_price": 10,
    "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/variation.jpg",
    "product_id": 6,
    "barcode": null,
    "norder": 1
  },
  {
    "id": 27,
    "main": false,
    "available": true,
    "sku": "13001",
    "name": "Tamanho: PP | Cor: Branca",
    "slug": "camiseta",
    "min_quantity": 1,
    "quantity": 85,
    "stock": 83,
    "custom_attributes": {
      "size": "PP",
      "color": "#FFFFFF"
    },
    "properties": {},
    "updated_at": "2019-08-01T18:36:52.718-03:00",
    "price": 169.9,
    "installments": [
      169.9
    ],
    "available_quantity": 83,
    "weight": 0.1,
    "width": 11,
    "height": 2,
    "length": 16,
    "handling_days": 0,
    "inventories": [],
    "sale_price": 169.9,
    "image_url": "//b0.vnda.com.br/x120/shop/2014/07/08/camiseta.jpg",
    "product_id": 6,
    "barcode": null,
    "norder": 1
  }
]