Pular para o conteúdo
Olist Ecommerce

Retorna um produto

GET
/api/v2/products/{id}

Retorna um produto

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

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

Query Parameters

Seção intitulada “Query Parameters ”
coupon_codes
Array<string>

Lista de cupons para calcular o desconto do produto

include_inventory_place
string

Se “true”, inclui o nome do local nos inventários das variantes

include_images
string

Se “true”, inclui todas as imagens do produto

Responses

Seção intitulada “ Responses ”

200

Seção intitulada “200 ”

Quando o produto é encontrado

Product

Modelo que representa um produto na API

object
id
integer
active
boolean
available
boolean
category_tags
Array<object>
object
tag_type
string
name
string
title
string
description
string
discount_id
integer
html_description
string
image_url
string
installments
Array<number>
min_quantity
string
name
string
on_sale
boolean
plain_description
string
price
number
rating
object
rating
integer
votes
integer
reference
string
sale_price
number
slug
string
tag_names
Array<string>
updated_at
string
url
string
variants
Array<object>
object
{id}

Modelo que representa uma variante na API

object
available
required
boolean
available_quantity
required
integer
custom_attributes
required
object
handling_days
required
integer
height
required
number
id
integer
>= 1
image_url
required
string
>= 1 characters
installments
required
Array<number>
inventories
Array<object>

Modelo que representa um inventory da variante na API

object
id
required
integer
name
string
nullable
place_id
required
integer
place_name
string
nullable
price
required
number
quantity
required
integer
quantity_sold
required
integer
sale_price
required
number
slug
required
string
>= 1 characters
updated_at
required
string format: date-time
variant_id
required
integer
length
required
number
main
required
boolean
min_quantity
required
integer
name
required
string
>= 1 characters
norder
required
integer
price
required
number
product_id
required
integer
properties
required
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
quantity
required
integer
quantity_sold
integer
sale_price
required
number
sku
required
string
>= 1 characters
slug
required
string
>= 1 characters
stock
required
integer
updated_at
required
string format: date-time
weight
required
number
width
required
number
discount_rule
required
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
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

Seção intitulada “404 ”

Quando o produto não é encontrado

Product

Modelo que representa um produto na API

object
id
integer
active
boolean
available
boolean
category_tags
Array<object>
object
tag_type
string
name
string
title
string
description
string
discount_id
integer
html_description
string
image_url
string
installments
Array<number>
min_quantity
string
name
string
on_sale
boolean
plain_description
string
price
number
rating
object
rating
integer
votes
integer
reference
string
sale_price
number
slug
string
tag_names
Array<string>
updated_at
string
url
string
variants
Array<object>
object
{id}

Modelo que representa uma variante na API

object
available
required
boolean
available_quantity
required
integer
custom_attributes
required
object
handling_days
required
integer
height
required
number
id
integer
>= 1
image_url
required
string
>= 1 characters
installments
required
Array<number>
inventories
Array<object>

Modelo que representa um inventory da variante na API

object
id
required
integer
name
string
nullable
place_id
required
integer
place_name
string
nullable
price
required
number
quantity
required
integer
quantity_sold
required
integer
sale_price
required
number
slug
required
string
>= 1 characters
updated_at
required
string format: date-time
variant_id
required
integer
length
required
number
main
required
boolean
min_quantity
required
integer
name
required
string
>= 1 characters
norder
required
integer
price
required
number
product_id
required
integer
properties
required
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
quantity
required
integer
quantity_sold
integer
sale_price
required
number
sku
required
string
>= 1 characters
slug
required
string
>= 1 characters
stock
required
integer
updated_at
required
string format: date-time
weight
required
number
width
required
number
discount_rule
required
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