Retorna um produto

Authorizations

Token
X-Shop-Host

Path Parameters

product_id

required

string

Código identificador ID do produto

Query Parameters

coupon_codes

Array<string>

Cupons para calcular o desconto no produto consultado

include_inventory_place

string

Selecione true para incluir o nome do local de armazenamento no retorno da requisição

include_images

string

Selecione true para incluir todas as imagens do produto

200

Produto encontrado

Product

Modelo que representa um produto na API

object

id

Código identificador ID do priduto

integer

active

Indica se o produto está ativo (true) ou invativo (false)

boolean

available

Indica se o produto está disponível (true) ou indisponível (false)

boolean

category_tags

Array<object>

object

tag_type

Tipo de tag

string

name

Nome da tag

string

title

Título da tag

string

Example

[
  {
    "tag_type": "flag",
    "name": "tag-veganos",
    "title": "Veg"
  },
  {
    "tag_type": "flag",
    "name": "liquida10",
    "title": "10OFF"
  }
]

description

Descrição do produto

string

discount_id

Código de desconto

integer

html_description

Descrição do produto em HTML

string

image_url

URL da imagem do produto

string

installments

Relação das parcelas para pagamento parcelado

Array<number>

min_quantity

Quantidade mínima para venda do produto

string

name

Nome do produto

string

on_sale

Indica se o produto está em promoção (true) ou não (false)

boolean

plain_description

Descrição simplificada

string

price

Preço do item

number

rating

Média de avaliação do produto

object

rating

integer

votes

integer

reference

Código de referência do produto

string

sale_price

Preço promocional

number

slug

Slug do produto

string

tag_names

Lista de tags que o produto é associado

Array<string>

updated_at

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

string

url

URL do produto

string

variants

Variantes do produto

Array<object>

object

{id}

Modelo que representa uma variante na API

object

available

required

boolean

available_quantity

required

integer

custom_attributes

required

Customização da variante

object

handling_days

required

Dias de manuseio da variante

integer

height

required

number

id

integer

>= 1

image_url

required

URL da imagem da variante

string

>= 1 characters

installments

required

Array<number>

inventories

Array<object>

Modelo que representa um inventory da variante na API

object

id

required

Código identificador ID do inventário

integer

name

Nome do inventário

string

nullable

place_id

required

Código identificador do local

integer

place_name

Nome do local

string

nullable

price

required

Preço do item

number

quantity

required

Quantidade de itens no inventário

integer

quantity_sold

required

Quantidade de itens vendidos

integer

sale_price

required

Preço promocional

number

slug

required

Slug do inventário

string

>= 1 characters

updated_at

required

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

string format: date-time

variant_id

required

Código da variante

integer

created_at

required

Data de criação do inventário

string format: date-time

Example

{
  "inventories": {
    "id": 524,
    "slug": "normandia",
    "price": 132,
    "sale_price": 0,
    "quantity": 500,
    "quantity_sold": 0,
    "name": null,
    "variant_id": 532,
    "updated_at": "2022-12-15T10:44:36.456-03:00",
    "place_id": 3
  }
}

length

required

number

main

required

boolean

min_quantity

required

Quantidade mínima para venda

integer

name

required

Nome da variante

string

>= 1 characters

norder

required

integer

price

required

Preço do item

number

product_id

required

integer

properties

required

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
  }
}

quantity

required

integer

quantity_sold

Quantidade de itens vendidos

integer

sale_price

required

Preço promocional

number

sku

required

string

>= 1 characters

slug

required

string

>= 1 characters

stock

required

Quantidade de itens disponíveis

integer

updated_at

required

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

string format: date-time

weight

required

Massa do produto, em gramas

number

width

required

Largura do produto, em centímetros

number

discount_rule

required

Regras de desconto de uma promoção

object

type

required

string

Allowed values: fixed percentage

amount

required

number

images

Imagens do produto

Array<object>

object

id

Id do produto

integer

url

Url do produto

string

updated_at

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

string

variant_ids

Array<object>

object

Example

[
  {
    "id": 0,
    "url": "https://b0.vnda.com.br/product.gif?v=1514479363",
    "updated_at": "2017-12-28T14:42:43.000-02:00",
    "variant_ids": [
      0
    ]
  }
]

Examples

{
  "id": 0,
  "active": true,
  "available": true,
  "category_tags": [
    {
      "tag_type": "string",
      "name": "string",
      "title": "string"
    }
  ],
  "description": "string",
  "discount_id": 0,
  "html_description": "string",
  "image_url": "string",
  "installments": [
    0
  ],
  "min_quantity": "string",
  "name": "string",
  "on_sale": true,
  "plain_description": "string",
  "price": 0,
  "rating": {
    "rating": 0,
    "votes": 0
  },
  "reference": "string",
  "sale_price": 0,
  "slug": "string",
  "tag_names": [
    "string"
  ],
  "updated_at": "string",
  "url": "string",
  "variants": [
    {
      "{id}": {
        "available": true,
        "available_quantity": 0,
        "custom_attributes": {},
        "handling_days": 0,
        "height": 0,
        "id": 1,
        "image_url": "string",
        "installments": [
          0
        ],
        "inventories": [
          {
            "created_at": "2019-08-24T14:15:22Z",
            "id": 0,
            "name": null,
            "place_id": 0,
            "price": 0,
            "quantity": 0,
            "quantity_sold": 0,
            "sale_price": 0,
            "slug": "string",
            "updated_at": "2019-08-24T14:15:22Z",
            "variant_id": 0,
            "place_name": "string"
          }
        ],
        "length": 0,
        "main": true,
        "min_quantity": 0,
        "name": "string",
        "norder": 0,
        "price": 0,
        "product_id": 0,
        "properties": {
          "property1": {
            "defining": true,
            "name": "string",
            "value": "string"
          },
          "property2": {
            "defining": true,
            "name": "string",
            "value": "string"
          },
          "property3": {
            "defining": true,
            "name": "string",
            "value": "string"
          }
        },
        "quantity": 0,
        "quantity_sold": 0,
        "sale_price": 0,
        "sku": "string",
        "slug": "string",
        "stock": 0,
        "updated_at": "2019-08-24T14:15:22Z",
        "weight": 0,
        "width": 0
      }
    }
  ],
  "discount_rule": null,
  "images": [
    {
      "id": 0,
      "url": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "variant_ids": [
        0
      ]
    }
  ]
}

404

Produto não encontrado

Product

Modelo que representa um produto na API

object

id

Código identificador ID do priduto

integer

active

Indica se o produto está ativo (true) ou invativo (false)

boolean

available

Indica se o produto está disponível (true) ou indisponível (false)

boolean

category_tags

Array<object>

object

tag_type

Tipo de tag

string

name

Nome da tag

string

title

Título da tag

string

Example

[
  {
    "tag_type": "flag",
    "name": "tag-veganos",
    "title": "Veg"
  },
  {
    "tag_type": "flag",
    "name": "liquida10",
    "title": "10OFF"
  }
]

description

Descrição do produto

string

discount_id

Código de desconto

integer

html_description

Descrição do produto em HTML

string

image_url

URL da imagem do produto

string

installments

Relação das parcelas para pagamento parcelado

Array<number>

min_quantity

Quantidade mínima para venda do produto

string

name

Nome do produto

string

on_sale

Indica se o produto está em promoção (true) ou não (false)

boolean

plain_description

Descrição simplificada

string

price

Preço do item

number

rating

Média de avaliação do produto

object

rating

integer

votes

integer

reference

Código de referência do produto

string

sale_price

Preço promocional

number

slug

Slug do produto

string

tag_names

Lista de tags que o produto é associado

Array<string>

updated_at

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

string

url

URL do produto

string

variants

Variantes do produto

Array<object>

object

{id}

Modelo que representa uma variante na API

object

available

required

boolean

available_quantity

required

integer

custom_attributes

required

Customização da variante

object

handling_days

required

Dias de manuseio da variante

integer

height

required

number

id

integer

>= 1

image_url

required

URL da imagem da variante

string

>= 1 characters

installments

required

Array<number>

inventories

Array<object>

Modelo que representa um inventory da variante na API

object

id

required

Código identificador ID do inventário

integer

name

Nome do inventário

string

nullable

place_id

required

Código identificador do local

integer

place_name

Nome do local

string

nullable

price

required

Preço do item

number

quantity

required

Quantidade de itens no inventário

integer

quantity_sold

required

Quantidade de itens vendidos

integer

sale_price

required

Preço promocional

number

slug

required

Slug do inventário

string

>= 1 characters

updated_at

required

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

string format: date-time

variant_id

required

Código da variante

integer

created_at

required

Data de criação do inventário

string format: date-time

Example

{
  "inventories": {
    "id": 524,
    "slug": "normandia",
    "price": 132,
    "sale_price": 0,
    "quantity": 500,
    "quantity_sold": 0,
    "name": null,
    "variant_id": 532,
    "updated_at": "2022-12-15T10:44:36.456-03:00",
    "place_id": 3
  }
}

length

required

number

main

required

boolean

min_quantity

required

Quantidade mínima para venda

integer

name

required

Nome da variante

string

>= 1 characters

norder

required

integer

price

required

Preço do item

number

product_id

required

integer

properties

required

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
  }
}

quantity

required

integer

quantity_sold

Quantidade de itens vendidos

integer

sale_price

required

Preço promocional

number

sku

required

string

>= 1 characters

slug

required

string

>= 1 characters

stock

required

Quantidade de itens disponíveis

integer

updated_at

required

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

string format: date-time

weight

required

Massa do produto, em gramas

number

width

required

Largura do produto, em centímetros

number

discount_rule

required

Regras de desconto de uma promoção

object

type

required

string

Allowed values: fixed percentage

amount

required

number

images

Imagens do produto

Array<object>

object

id

Id do produto

integer

url

Url do produto

string

updated_at

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

string

variant_ids

Array<object>

object

Example

[
  {
    "id": 0,
    "url": "https://b0.vnda.com.br/product.gif?v=1514479363",
    "updated_at": "2017-12-28T14:42:43.000-02:00",
    "variant_ids": [
      0
    ]
  }
]

Retorna um produto

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

Example

Example

Example

Example

Example

Examples

404

Example

Example

Example

Example

Example

Example