Retorna uma variante

GET

/api/v2/variants/{sku}

• Servidor do ambiente de produção
• Servidor do ambiente de testes

Retorna uma variante pelo SKU

Authorizations

• Token
• X-Shop-Host

Parameters

Path Parameters

sku

required

string

SKU da variante

Responses

201

Quando a variante é encontrada

Variant

Modelo que representa uma variante na API

object

id

Código identificador da variante

integer

main

Identifica se é a variante principal do produto. Para true a variante é principal e false a variante é secundária

boolean

available

Identifica se a variante está ativa em true e desativa em false

boolean

sku

Código SKU da variante

string

name

Nome da variante

string

slug

Slug da URL da variante

string

min_quantity

Quantidade mínima para venda

integer

quantity

Quantidade física de itens

integer

quantity_sold

Quantidade de itens vendidos

integer

stock

Unidades de itens disponíveis

integer

custom_attributes

Customização da variante

object

properties

Atributos da variante

object

property1

variant_property

Modelo que representa uma propriedade customizada na API

object

defining

required

Indica se a variante possui uma definição (true) ou se a variante não possui (false)

boolean

name

required

Nome da propriedade

string

value

Valor da propriedade

string

Example

{
  "example-property1": {
    "name": "Tamanho",
    "value": "G",
    "defining": true
  },
  "example-property2": {
    "name": "Cor",
    "value": "Amarelo",
    "defining": true
  }
}

property2

variant_property

Modelo que representa uma propriedade customizada na API

object

defining

required

Indica se a variante possui uma definição (true) ou se a variante não possui (false)

boolean

name

required

Nome da propriedade

string

value

Valor da propriedade

string

Example

{
  "example-property1": {
    "name": "Tamanho",
    "value": "G",
    "defining": true
  },
  "example-property2": {
    "name": "Cor",
    "value": "Amarelo",
    "defining": true
  }
}

property3

variant_property

Modelo que representa uma propriedade customizada na API

object

defining

required

Indica se a variante possui uma definição (true) ou se a variante não possui (false)

boolean

name

required

Nome da propriedade

string

value

Valor da propriedade

string

Example

{
  "example-property1": {
    "name": "Tamanho",
    "value": "G",
    "defining": true
  },
  "example-property2": {
    "name": "Cor",
    "value": "Amarelo",
    "defining": true
  }
}

updated_at

Data e horário da última atualização da variante

string format: date-time

price

Preço do item

number

installments

Relação das parcelas para pagamento do item parcelado

Array<number>

available_quantity

Unidades reservadas e não reservadas do item

integer

weight

Massa do produto, em gramas

number

width

Largura do produto, em centímetros

number

height

Altura do produto, em centímetros

number

length

Comprimento do produito, em centímetros

number

handling_days

Dias de manuseio da variante

integer

inventories

Relação de itens por estoque (armazém)

Array<object>

Modelo que representa um inventário da variante

object

id

required

integer

>= 1

name

required

string

>= 1 characters

place_id

required

integer

price

required

Preço do item

number

quantity

required

integer

quantity_sold

required

Quantidade de itens vendidos

integer

sale_price

required

Preço promocional

number

slug

required

string

sale_price

Preço promocional

number

intl_price

Preço internacional

number

image_url

URL da imagem da variante

string

product_id

Código identificador ID do produto

integer

barcode

Código de barra da variante

string

nullable

norder

integer

Examples

{
  "id": 95,
  "main": false,
  "available": true,
  "sku": "SHOP0001",
  "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,
  "norder": 1
}

404

Quando a variante não é encontrada

404

Domínio de loja não encontrado

object

error

required

string

Allowed values: not found