Listagem de Variações

Requisição para consultar os dados de diversas variações.

Método GET

https://{api_address}/products/variants/

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";
    $params["limit"] = "5";

    $url = "https://{api_address}/products/variants/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/products/variants/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");    
queryParameters.Add("limit", "5");    

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
String url = "https://{api_address}/products/variants/";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");
mapToConvert.put("limit", "5");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

id Number

Código da variação

product_id Number

Código do produto principal

ean String

EAN da variação

price Decimal

Preço da variação

promotional_price Decimal

Preço promocional da variação

stock Number

Estoque da variação

minimum_stock Number

Estoque mínimo da variação

modified Date

Data de modificação (Pode-se enviar um intervalo de data, ex.: [start], [end] (Formato: aaaa-mm-dd))

sort String

Ordenação de listagem (ex.: [campo]_[asc/desc])

limit Number

Quantidade de registros (max. 50)

page Number

Número da página da consulta

Success 200

Campo Tipo Descrição
paging Object

Dados de raginação

  total Number

Total de tegistros

  page Number

Páginas corrente

  offset Number

Registro inicial da página

  limit Number

Limite de registros

  maxLimit Number

Máximo de registros

sort Object[]

Ordenação

availableFilters String[]

Filtros disponíveis

appliedFilters String[]

Filtros utilizados

Variants Object[]

Dados da variações dos produtos

  Variant Object

Dados da variação

    id Number

Código da variação

    ean String

Código EAN da variação

order String

Ordem da visualização da variação

    product_id Number

Código

    price Decimal

Preço da variação

    cost_price Decimal

Preço da variação de custo da variação

    stock Number

Estoque da variação

    minimum_stock Number

Estoque mínimo da variação

    reference String

Referência da variação

    weight Decimal

Peso da variação

    cubic_weight Decimal

Peso cubico da variação

    length Decimal

Comprimento da variação

    width Decimal

Largura da variação

    height Decimal

Altura da variação

    start_promotion Date

Data de início de promoção da variação

    end_promotion Date

Data de termino de promoção da variação

    promotional_price Decimal

Preço promocional da variação

    payment_option String

Detalhes/Opções de pagamento da variação

    payment_option_details Object[]

Detalhes/Opções separadas de pagamento da variação

      display_name String

Nome da forma de pagamento da variação

type String

Typo da forma de pagamento da variação

      plots Number

Quantidade de parcelas da forma de pagamento da variação

      value Decimal

Valor da parcela da forma de pagamento da variação

tax Decimal

Taxa da parcela da forma de pagamento da variação

    available Number

Variação disponível (Veja Tabela A)

    illustrative_image String

Imagem ilustrativa da variação

    color_id_1 String

Código da cor primária da variação

    color_id_2 String

Código da cor secundaria da variação

      type String

Tipo de SKU da variação

      value String

Valor do SKU da variação

      image String

URL da imagem do SKU da variação

      image_secure String

URL segura da imagem do SKU da variação

    VariantImage Object[]

Imagens da variação

      http String

URL da imagem da variação

      https String

URL segura da imagem da variação

      thumbs Object

Miniaturas da imagem da variação

        30 Object

Miniaturas da imagem da variação (30px)

          http String

URL da miniaturas da imagem da variação (30px)

          https String

URL segura da miniaturas da imagem da variação (30px)

        90 Object

Miniaturas da imagem (90px)

          http String

URL da miniaturas da imagem da variação (90px)

          https String

URL segura da miniaturas da imagem da variação (90px)

        180 Object

Miniaturas da imagem da variação (180px)

          http String

URL da miniaturas da imagem da variação (180px)

          https String

URL segura da miniaturas da imagem da variação (180px)

{
    "paging": {
        "total": 55,
        "page": 1,
        "offset": 0,
        "limit": 30,
        "maxLimit": 50
    },
    "sort": [
        {
            "id": "asc"
        }
    ],
    "availableFilters": [
        "id",
        "product_id",
        "ean",
        "price",
        "promotional_price",
        "stock",
        "minimum_stock",
        "value_1",
        "reference",
        "value_2",
        "type_1",
        "type_2",
        "modified"
    ],
    "appliedFilters": [],
    "Variants": [
        {
            "Variant": {
                "id": "1233",
                "ean": "123",
                "order": "1",
                "product_id": "18",
                "price": "12.50",
                "cost_price": "10.00",
                "stock": "51",
                "minimum_stock": "1",
                "reference": "THR016-1",
                "weight": "21",
                "length": "21",
                "width": "21",
                "height": "21",
                "start_promotion": "2019-01-01",
                "end_promotion": "2019-01-10",
                "promotional_price": "10.00",
                "payment_option": "R$ 11,25 à vista com desconto Boleto - Yapay",
                "payment_option_details": [
                    {
                        "display_name": "Boleto - Yapay",
                        "type": "bank_billet",
                        "plots": "1",
                        "value": "11.25",
                        "tax": "0.00"
                    }
                ],
                "available": "1",
                "illustrative_image": {
                    "http": "http://urldaimagem/img/img_prod/123/123.png",
                    "https": "https://urldaimagem/img/img_prod/123/123.png"
                },
                "quantity_sold": "10",
                "color_id_1": "2",
                "color_id_2": "0",
                "cubic_weight": "1930",
                "Sku": [
                    {
                        "type": "Cor",
                        "value": "Azul",
                        "image": "http://urldaimagem/img/img_prod/123/cor_2.png?20160622100723",
                        "image_secure": "https://urldaimagem/img/img_prod/123/cor_2.png?20160622100723"
                    },
                    {
                        "type": "Tamanho",
                        "value": "38"
                    }
                ],
                "VariantImage": [
                    {
                        "http": "http://urldaimagem/img/img_prod/123/123.png",
                        "https": "https://urldaimagem/img/img_prod/123/123.png",
                        "thumbs": {
                            "30": {
                                "http": "http://urldaimagem/img/img_prod/123/30_123.png",
                                "https": "https://urldaimagem/img/img_prod/123/30_123.png"
                            },
                            "90": {
                                "http": "http://urldaimagem/img/img_prod/123/90_123.png",
                                "https": "https://urldaimagem/img/img_prod/123/90_123.png"
                            },
                            "180": {
                                "http": "http://urldaimagem/img/img_prod/123/180_123.png",
                                "https": "https://urldaimagem/img/img_prod/123/180_123.png"
                            }
                        }
                    }
                ]
            }
        }
    ]
}


Consultar Dados da Variação

Requisição para consultar os dados de uma variação do produto.

Método GET

https://{api_address}/products/variants/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/products/variants/1?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/products/variants/1";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");    

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

WebRequest request = WebRequest.Create(URLAuth + "?" + argsString);
    
request.Credentials = CredentialCache.DefaultCredentials;
    
WebResponse response = request.GetResponse();
  
Console.WriteLine(((HttpWebResponse)response).StatusDescription);
    
Stream dataStream = response.GetResponseStream();
    
StreamReader reader = new StreamReader(dataStream);

string responseData = reader.ReadToEnd();

Console.WriteLine(responseData);
reader.Close();
response.Close();
String url = "https://{api_address}/products/variants/1";

Map<String, String> mapToConvert = new HashMap<>();
mapToConvert.put("access_token", "### Chave de Acesso ###");

String queryString = "";

for (Entry<String, String> entry : mapToConvert.entrySet()) {
    queryString += entry.getKey()+"="+ entry.getValue()+"&";
}

try {
    URL obj = new URL(url+"?"+queryString);
    HttpURLConnection con = (HttpURLConnection) obj.openConnection();
    
    con.setRequestMethod("GET");
    con.setRequestProperty("User-Agent", USER_AGENT);

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode >= 200 && responseCode < 300){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    StringBuilder response = new StringBuilder();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();
    
    String resposta = response.toString();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id Number

Código da Variação do produto

Retorno em caso de sucesso

Campo Tipo Descrição
Variant Object

Dados da variação

id Number

Código da variação

ean String

Código EAN da variação

order String

Ordem da visualização da variação

product_id Number

Código da variação

price Decimal

Preço da variação

cost_price Decimal

Preço da variação de custo da variação

stock Number

Estoque da variação

minimum_stock Number

Estoque mínimo da variação

reference String

Referência da variação

weight Decimal

Peso da variação

cubic_weight Decimal

Peso cubico da variação

length Decimal

Comprimento da variação

width Decimal

Largura da variação

height Decimal

Altura da variação

start_promotion Date

Data de início de promoção da variação

end_promotion Date

Data de termino de promoção da variação

promotional_price Decimal

Preço promocional da variação

payment_option String

Detalhes/Opções de pagamento da variação

payment_option_details Object[]

Detalhes/Opções separadas de pagamento da variação

display_name String

Nome da forma de pagamento da variação

type String

Tipo da forma de pagamento da variação

plots Number

Quantidade de parcelas da forma de pagamento da variação

value Decimal

Valor da parcela de pagamento da variação

tax Decimal

Valor da taxa da parcela da forma de pagamento da variação

available Number

Variação disponível (Veja Tabela A)

illustrative_image String

Imagem ilustrativa da variação

color_id_1 String

Código da cor primária da variação

color_id_2 String

Código da cor secundaria da variação

Sku String

SKU da variação

type String

Tipo de SKU da variação

value String

Valor do SKU da variação

image String

URL da imagem do SKU da variação

image_secure String

URL segura da imagem do SKU da variação

VariantImage Object[]

Imagens da variação

http String

URL da imagem da variação

https String

URL segura da imagem da variação

thumbs Object

Miniaturas da imagem da variação

30 Object

Miniaturas da imagem da variação (30px)

http String

URL da miniaturas da imagem da variação (30px)

https String

URL segura da miniaturas da imagem da variação (30px)

90 Object

Miniaturas da imagem (90px)

http String

URL da miniaturas da imagem da variação (90px)

https String

URL segura da miniaturas da imagem da variação (90px)

180 Object

Miniaturas da imagem da variação (180px)

http String

URL da miniaturas da imagem da variação (180px)

https String

URL segura da miniaturas da imagem da variação (180px)

{
    "Variant": {
        "id": "255",
        "ean": "125",
        "order": "1",
        "product_id": "18",
        "price": "12.50",
        "cost_price": "10.00",
        "stock": "51",
        "minimum_stock": "1",
        "reference": "THR016-2",
        "weight": "21",
        "cubic_weight": "1930",
        "length": "21",
        "width": "21",
        "height": "21",
        "start_promotion": "2019-01-01",
        "end_promotion": "2019-01-10",
        "promotional_price": "10.00",
        "payment_option": "R$ 11,25 à vista com desconto Boleto - Yapay",
        "payment_option_details": [
            {
                "display_name": "Boleto - Yapay",
                "type": "bank_billet",
                "plots": "1",
                "value": "11.25",
                "tax": "0.00"
            }
        ],
        "available": "1",
        "illustrative_image": "",
        "Sku": [
            {
                "type": "Cor",
                "value": "Preta"
            },
            {
                "type": "Tamanho",
                "value": "40"
            }
        ],
        "quantity_sold": "10",
        "color_id_1": "23",
        "color_id_2": "0",
        "VariantImage": [
            {
                "http": "http://images.tcdn.com.br/img/img_prod/406562/18_123.jpg",
                "https": "https://images.tcdn.com.br/img/img_prod/406562/18_123.jpg",
                "thumbs": {
                    "30": {
                        "http": "http://images.tcdn.com.br/img/img_prod/123/30_123.jpg",
                        "https": "https://images.tcdn.com.br/img/img_prod/123/30_123.jpg"
                    },
                    "90": {
                        "http": "http://images.tcdn.com.br/img/img_prod/123/90_123.jpg",
                        "https": "https://images.tcdn.com.br/img/img_prod/123/90_123.jpg"
                    },
                    "180": {
                        "http": "http://images.tcdn.com.br/img/img_prod/123/180_123.jpg",
                        "https": "https://images.tcdn.com.br/img/img_prod/123/180_123.jpg"
                    }
                }
            }
        ]
    }
}


Cadastrar Variação

Requisição para inclusão de variação do produto. Deverá enviar o JSON com os dados da variação para a criação.

Método POST

https://{api_address}/products/variants/

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $data["Variant"]["product_id"] = "123";
    $data["Variant"]["ean"] = "ABC";
    $data["Variant"]["order"] = 1;
    $data["Variant"]["price"] = 12.00;
    $data["Variant"]["cost_price"] = 10.00;
    $data["Variant"]["stock"] = 200;
    $data["Variant"]["minimum_stock"] = 10;
    $data["Variant"]["reference"] = "THR016-1";
    $data["Variant"]["weight"] = 21;
    $data["Variant"]["length"] = 21;
    $data["Variant"]["width"] = 21;
    $data["Variant"]["height"] = 21;
    $data["Variant"]["start_promotion"] = "2019-01-01";
    $data["Variant"]["end_promotion"] = "2019-01-10";
    $data["Variant"]["promotional_price"] = 10.00;
    $data["Variant"]["promotional_price"] = 10.00;
    $data["Variant"]["promotional_price"] = 10.00;
    $data["Variant"]["Sku"][0]["type"] = "Cor";
    $data["Variant"]["Sku"][0]["value"] = "Azul";
    $data["Variant"]["Sku"][1]["type"] = "Tamanho";
    $data["Variant"]["Sku"][1]["value"] = "38";
    $data["Variant"]["quantity_sold"] = "10";

    $url = "https://{api_address}/products/variants/?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen(json_encode($data)))
    );
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/products/variants/";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

string postString  = "{";
       postString += "  \"Variant\": {";
       postString += "      \"product_id\": \"123\",";
       postString += "      \"ean\": \"ABC\",";
       postString += "      \"order\": \"1\",";
       postString += "      \"price\": 12.00,";
       postString += "      \"cost_price\": 10.00,";
       postString += "      \"stock\": 51,";
       postString += "      \"minimum_stock\": 1,";
       postString += "      \"reference\": \"THR016-1\",";
       postString += "      \"weight\": 21,";
       postString += "      \"length\": 21,";
       postString += "      \"width\": 21,";
       postString += "      \"height\": 21,";
       postString += "      \"start_promotion\": \"2019-01-01\",";
       postString += "      \"end_promotion\": \"2019-01-10\",";
       postString += "      \"promotional_price\": 10.00,";
       postString += "      \"Sku\": [";
       postString += "          {";
       postString += "              \"type\": \"Cor\",";
       postString += "              \"value\": \"Azul\"";
       postString += "          },";
       postString += "          {";
       postString += "              \"type\": \"Tamanho\",";
       postString += "              \"value\": \"38\"";
       postString += "          }";
       postString += "      ],";
       postString += "      \"quantity_sold\": 10";
       postString += "  }";
       postString += "}";

HttpWebRequest webRequest = WebRequest.Create(URLAuth + "?" + argsString) as HttpWebRequest;
webRequest.Method = "POST";
webRequest.ContentType = "application/json";

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(postString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();

responseReader.Close();
webRequest.GetResponse().Close();
String url = "https://{api_address}/products/variants/";
StringBuffer response = null ;
try{
    String access_token = "?access_token=### Chave de Acesso ###";
    
    URL obj = new URL(url+access_token);
    HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();

    //add reuqest header
    con.setRequestMethod("POST");
    con.setRequestProperty("User-Agent", USER_AGENT);
    con.setRequestProperty("Content-Type", "application/json");
    con.setRequestProperty("Accept-Language", "en-US,en;q=0.5");

    String postString  = "{";
       postString += "  \"Variant\": {";
       postString += "      \"product_id\": \"123\",";
       postString += "      \"ean\": \"ABC\",";
       postString += "      \"order\": \"1\",";
       postString += "      \"price\": 12.00,";
       postString += "      \"cost_price\": 10.00,";
       postString += "      \"stock\": 51,";
       postString += "      \"minimum_stock\": 1,";
       postString += "      \"reference\": \"THR016-1\",";
       postString += "      \"weight\": 21,";
       postString += "      \"length\": 21,";
       postString += "      \"width\": 21,";
       postString += "      \"height\": 21,";
       postString += "      \"start_promotion\": \"2019-01-01\",";
       postString += "      \"end_promotion\": \"2019-01-10\",";
       postString += "      \"promotional_price\": 10.00,";
       postString += "      \"Sku\": [";
       postString += "          {";
       postString += "              \"type\": \"Cor\",";
       postString += "              \"value\": \"Azul\"";
       postString += "          },";
       postString += "          {";
       postString += "              \"type\": \"Tamanho\",";
       postString += "              \"value\": \"38\"";
       postString += "          }";
       postString += "      ],";
       postString += "      \"quantity_sold\": 10";
       postString += "  }";
       postString += "}";
           
    // Send put request
    con.setDoOutput(true);
    DataOutputStream wr = new DataOutputStream(con.getOutputStream());
    wr.writeBytes(postString);
    wr.flush();
    wr.close();

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode == 200){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    response = new StringBuffer();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

Variant JSON

Dados da variação

product_id Number

Código do produto principal

ean String

EAN da variação

order Number

Ordem da visualização da variação

price Decimal

Preço da variação

cost_price Decimal

Preço de custo da variação

stock Number

Estoque da variação

minimum_stock Number

Estoque mínimo da variação

reference String

Referência da variação

weight Number

Peso da variação

length Number

Comprimento da variação

width Number

Largura da variação

height Number

Altura da variação

start_promotion Date

Data de início da promoção da variação (Formato: aaaa-mm-dd)

end_promotion Date

Data de termino da promoção da variação (Formato: aaaa-mm-dd)

promotional_price Decimal

Preço promocional da variação

type String

Tipo de sku da variação

value String

Valor de sku da variação

picture_source_1 String

Imagem principal do produto (URL da imagem) (Obrigatório enviar o product_id)

picture_source_2 String

Imagem do produto - imagem 2 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_3 String

Imagem do produto - imagem 3 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_4 String

Imagem do produto - imagem 4 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_5 String

Imagem do produto - imagem 5 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_6 String

Imagem do produto - imagem 6 (URL da imagem) (Obrigatório enviar o product_id)

quantity_sold Number

Quantidade vendida da variação

{
    "Variant": {
        "product_id": "18",
        "ean": "125",
        "order": "1",
        "price": "12.50",
        "cost_price": "10.00",
        "stock": "51",
        "minimum_stock": "1",
        "reference": "THR016-2",
        "weight": "21",
        "length": "21",
        "width": "21",
        "height": "21",
        "start_promotion": "2019-01-01",
        "end_promotion": "2019-01-10",
        "promotional_price": "10.00",
        "type_1": "Cor",
        "value_1": "Preta"
        "type_2": "Tamanho",
        "value_2": "40"
        "quantity_sold": "10",
        "picture_source_1": "http://urldaimagem.com.br/img/imagem1.jpg",
        "picture_source_2": "http://urldaimagem.com.br/img/imagem2.jpg",
        "picture_source_3": "http://urldaimagem.com.br/img/imagem3.jpg",
        "picture_source_4": "http://urldaimagem.com.br/img/imagem4.jpg",
        "picture_source_5": "http://urldaimagem.com.br/img/imagem5.jpg",
        "picture_source_6": "http://urldaimagem.com.br/img/imagem6.jpg"
    }
}

Success 200

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

Código da variação

code Number

Código do retorno (201)

HTTP/1.1 201 OK
{
    "message": "Created",
    "id": "123",
    "code": 201
}

Atualizar Dados da Variação

Requisição para alterar os dados da variação. Deverá enviar o JSON com os dados da variação para alteração.

Método PUT

https://{api_address}/products/variants/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $data["Variant"]["ean"] = "ABC";
    $data["Variant"]["order"] = 1;
    $data["Variant"]["price"] = 12.00;
    $data["Variant"]["cost_price"] = 10.00;
    $data["Variant"]["stock"] = 200;
    $data["Variant"]["minimum_stock"] = 10;
    $data["Variant"]["reference"] = "THR016-1";
    $data["Variant"]["weight"] = 21;
    $data["Variant"]["length"] = 21;
    $data["Variant"]["width"] = 21;
    $data["Variant"]["height"] = 21;
    $data["Variant"]["start_promotion"] = "2019-01-01";
    $data["Variant"]["end_promotion"] = "2019-01-10";
    $data["Variant"]["promotional_price"] = 10.00;
    $data["Variant"]["promotional_price"] = 10.00;
    $data["Variant"]["promotional_price"] = 10.00;
    $data["Variant"]["Sku"][0]["type"] = "Cor";
    $data["Variant"]["Sku"][0]["value"] = "Azul";
    $data["Variant"]["Sku"][1]["type"] = "Tamanho";
    $data["Variant"]["Sku"][1]["value"] = "38";
    $data["Variant"]["quantity_sold"] = "10";

    $url = "https://{api_address}/products/variants/123?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
    curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen(json_encode($data)))
    );
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/products/variants/123";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

string putString  = "{";
       putString += "  \"Variant\": {";
       putString += "      \"ean\": \"ABC\",";
       putString += "      \"order\": \"1\",";
       putString += "      \"price\": 12.00,";
       putString += "      \"cost_price\": 10.00,";
       putString += "      \"stock\": 51,";
       putString += "      \"minimum_stock\": 1,";
       putString += "      \"reference\": \"THR016-1\",";
       putString += "      \"weight\": 21,";
       putString += "      \"length\": 21,";
       putString += "      \"width\": 21,";
       putString += "      \"height\": 21,";
       putString += "      \"start_promotion\": \"2019-01-01\",";
       putString += "      \"end_promotion\": \"2019-01-10\",";
       putString += "      \"promotional_price\": 10.00,";
       putString += "      \"Sku\": [";
       putString += "          {";
       putString += "              \"type\": \"Cor\",";
       putString += "              \"value\": \"Azul\"";
       putString += "          },";
       putString += "          {";
       putString += "              \"type\": \"Tamanho\",";
       putString += "              \"value\": \"38\"";
       putString += "          }";
       putString += "      ],";
       putString += "      \"quantity_sold\": 10";
       putString += "  }";
       putString += "}";

HttpWebRequest webRequest = WebRequest.Create(URLAuth + "?" + argsString) as HttpWebRequest;
webRequest.Method = "PUT";
webRequest.ContentType = "application/json";

StreamWriter requestWriter = new StreamWriter(webRequest.GetRequestStream());
requestWriter.Write(putString);
requestWriter.Close();

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();

responseReader.Close();
webRequest.GetResponse().Close();
String url = "https://{api_address}/products/variants/123";
StringBuffer response = null ;
try{
    String access_token = "?access_token=### Chave de Acesso ###";
    
    URL obj = new URL(url+access_token);
    HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();

    //add reuqest header
    con.setRequestMethod("PUT");
    con.setRequestProperty("User-Agent", USER_AGENT);
    con.setRequestProperty("Content-Type", "application/json");
    con.setRequestProperty("Accept-Language", "en-US,en;q=0.5");

    String putString  = "{";
       putString += "  \"Variant\": {";
       putString += "      \"ean\": \"ABC\",";
       putString += "      \"order\": \"1\",";
       putString += "      \"price\": 12.00,";
       putString += "      \"cost_price\": 10.00,";
       putString += "      \"stock\": 51,";
       putString += "      \"minimum_stock\": 1,";
       putString += "      \"reference\": \"THR016-1\",";
       putString += "      \"weight\": 21,";
       putString += "      \"length\": 21,";
       putString += "      \"width\": 21,";
       putString += "      \"height\": 21,";
       putString += "      \"start_promotion\": \"2019-01-01\",";
       putString += "      \"end_promotion\": \"2019-01-10\",";
       putString += "      \"promotional_price\": 10.00,";
       putString += "      \"Sku\": [";
       putString += "          {";
       putString += "              \"type\": \"Cor\",";
       putString += "              \"value\": \"Azul\"";
       putString += "          },";
       putString += "          {";
       putString += "              \"type\": \"Tamanho\",";
       putString += "              \"value\": \"38\"";
       putString += "          }";
       putString += "      ],";
       putString += "      \"quantity_sold\": 10";
       putString += "  }";
       putString += "}";
           
    // Send put request
    con.setDoOutput(true);
    DataOutputStream wr = new DataOutputStream(con.getOutputStream());
    wr.writeBytes(putString);
    wr.flush();
    wr.close();

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode == 200){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    response = new StringBuffer();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id Number

Código da variação

Variant JSON

Dados da variação

ean String

EAN da variação

order Number

Ordem da visualização da variação

price Decimal

Preço da variação

cost_price Decimal

Preço de custo da variação

stock Number

Estoque da variação

minimum_stock Number

Estoque mínimo da variação

reference String

Referência da variação

weight Number

Peso da variação

length Number

Comprimento da variação

width Number

Largura da variação

height Number

Altura da variação

start_promotion Date

Data de início da promoção da variação (Formato: aaaa-mm-dd)

end_promotion Date

Data de termino da promoção da variação (Formato: aaaa-mm-dd)

promotional_price Decimal

Preço promocional da variação

Sku Object[]

Sku da variação

type String

Tipo de sku da variação

value String

Valor de sku da variação

picture_source_1 String

Imagem principal do produto (URL da imagem) (Obrigatório enviar o product_id)

picture_source_2 String

Imagem do produto - imagem 2 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_3 String

Imagem do produto - imagem 3 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_4 String

Imagem do produto - imagem 4 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_5 String

Imagem do produto - imagem 5 (URL da imagem) (Obrigatório enviar o product_id)

picture_source_6 String

Imagem do produto - imagem 6 (URL da imagem) (Obrigatório enviar o product_id)

quantity_sold Number

Quantidade vendida da variação

{
    "Variant": {
        "ean": "123",
        "order": "2",
        "price": "12.50",
        "cost_price": "10.00",
        "stock": "51",
        "minimum_stock": "1",
        "reference": "THR016-1",
        "weight": "21",
        "length": "21",
        "width": "21",
        "height": "21",
        "start_promotion": "2019-01-01",
        "end_promotion": "2019-01-10",
        "promotional_price": "10.00",
        "Sku": [
            {
                "type": "Cor",
                "value": "Azul"
            },
            {
                "type": "Tamanho",
                "value": "38"
            }
        ],
        "quantity_sold": "10",
        "picture_source_1": "http://urldaimagem.com.br/img/imagem1.jpg",
        "picture_source_2": "http://urldaimagem.com.br/img/imagem2.jpg",
        "picture_source_3": "http://urldaimagem.com.br/img/imagem3.jpg",
        "picture_source_4": "http://urldaimagem.com.br/img/imagem4.jpg",
        "picture_source_5": "http://urldaimagem.com.br/img/imagem5.jpg",
        "picture_source_6": "http://urldaimagem.com.br/img/imagem6.jpg"
    }
}

Success 200

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

Código da variação

code Number

Código do retorno (200)

HTTP/1.1 200 OK
{
    "message": "Saved",
    "id": "123",
    "code": 200
}

Excluir Variação

Requisição para excluir uma variação do produto.

Método DELETE

https://{api_address}/products/variants/:id

Código de Exemplo

<?php
    $params["access_token"] = "### Chave de Acesso ###";

    $url = "https://{api_address}/products/variants/123?".http_build_query($params);

    ob_start();

    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");
    curl_setopt($ch, CURLOPT_HTTPHEADER, array(
        'Content-Type: application/json',
        'Content-Length: ' . strlen(json_encode($data)))
    );
    curl_exec($ch);

    // JSON de retorno  
    $resposta = json_decode(ob_get_contents());
    $code = curl_getinfo($ch, CURLINFO_HTTP_CODE);

    ob_end_clean();
    curl_close($ch);

    if($code == "200"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>
string URLAuth = "https://{api_address}/products/variants/123";

NameValueCollection queryParameters = new NameValueCollection();

queryParameters.Add("access_token", "### Chave de Acesso ###");

List items = new List();

foreach (String name in queryParameters)
    items.Add(String.Concat(name, "=", System.Web.HttpUtility.UrlEncode(queryParameters[name])));

string argsString = String.Join("&", items.ToArray());

HttpWebRequest webRequest = WebRequest.Create(URLAuth + "?" + argsString) as HttpWebRequest;
webRequest.Method = "DELETE";
webRequest.ContentType = "application/json";

StreamReader responseReader = new StreamReader(webRequest.GetResponse().GetResponseStream());
string responseData = responseReader.ReadToEnd();

responseReader.Close();
webRequest.GetResponse().Close();
String url = "https://{api_address}/products/variants/123";
StringBuffer response = null ;
try{
    String access_token = "?access_token=### Chave de Acesso ###";
    
    URL obj = new URL(url+access_token);
    HttpsURLConnection con = (HttpsURLConnection) obj.openConnection();

    //add reuqest header
    con.setRequestMethod("DELETE");
    con.setRequestProperty("User-Agent", USER_AGENT);
    con.setRequestProperty("Content-Type", "application/json");
    con.setRequestProperty("Accept-Language", "en-US,en;q=0.5");

    int responseCode = con.getResponseCode();

    BufferedReader in ;
    if (responseCode == 200){
        in = new BufferedReader(
            new InputStreamReader(con.getInputStream()));
    }else{
        in = new BufferedReader(
            new InputStreamReader(con.getErrorStream()));
    }
    
    String inputLine;
    response = new StringBuffer();

    while ((inputLine = in.readLine()) != null) {
            response.append(inputLine);
    }
    in.close();

} catch (Exception ex){
    // Tratamento da Exception
}

Parâmetro

Campo Tipo Descrição
access_token String

Chave de acesso

:id Number

Código da variação

Success 200

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

Código da variação

code Number

Código do retorno (200)

HTTP/1.1 200 OK
{
    "message": "Deleted",
    "id": "123",
    "code": 200
}

 

Tabelas Auxiliares

Tabelas Auxiliares de Produtos

Tabela A - Disponibilidade do produto (campo available)

Valor Descrição
0 Produto indisponível
1 Produto disponível
Frontend - Agencia 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção

    Powered by Zendesk