Atualização - additional_info

Requisição para atualizar as informações adicionais.

1 - Atualizar as informações adicionais.

Método PUT

https://{api_address}/additional_info/:id(additional_info)?access_token={token}

Código de Exemplo

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

    $data["AdditionalInfo"]["type"] = 1;
    $data["AdditionalInfo"]["name"] = "Time do coração?";
    $data["AdditionalInfo"]["display_value"] = 1;
    $data["AdditionalInfo"]["required"] = 1;
    $data["AdditionalInfo"]["add_total"] = 1;
    $data["AdditionalInfo"]["max_length"] = 12;
    $data["AdditionalInfo"]["value"] = 11.90;
    $data["AdditionalInfo"]["active"] = 1;

    $url = "https://{api_address}/additional_info/:id(additional_info)?".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_PUTFIELDS, 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 == "201"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/additional_info/:id(additional_info)";

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 += "  \"AdditionalInfo\": {";
       putString += "      \"type\": 1,";
       putString += "      \"name\": \"Time do coração?\",";
       putString += "      \"display_value\": \"1\",";
       putString += "      \"required\": \"1\",";
       putString += "      \"add_total\": \"1\",";
       putString += "      \"max_length\": \"12\",";
       putString += "      \"value\": \"11.90\",";
       putString += "      \"active\": 1,";
       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}/additional_info/:id(additional_info)";
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 += "  \"AdditionalInfo\": {";
           putString += "      \"type\": 1,";
           putString += "      \"name\": \"Time do coração?\",";
           putString += "      \"display_value\": \"1\",";
           putString += "      \"required\": \"1\",";
           putString += "      \"add_total\": \"1\",";
           putString += "      \"max_length\": \"12\",";
           putString += "      \"value\": \"11.90\",";
           putString += "      \"active\": 1,";
           putString += "  }";
           putString += "}";
           
    // Send post 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 && responseCode < 300){
        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
}
String resposta = response.toString();

Parâmetros enviados 

Campo Tipo (Tamanho) Descrição
  access_token String

Chave de acesso

  AdditionalInfo JSON

Informações adicionais do produto

  type String

Correspondo a forma como será exibida a informação adicional. Tabela A

  name String

Nome da informação adicional

  display_value Number

Se o valor será exibido. Tabela B

  required Number

Se será obrigatório ou não no momento da compra. Tabela C

  add_total Number

Se o valor será somado ou não ao produto. Tabela D

  max_length Number

Corresponde a quantidade de caracter que poderá ser inserido na informação adicional. Exemplo: Camisa de torcedor (possuirá dois dígitos)

  value Decimal

Valor do produto que estiver setado com a informação adicional

  active Number

Se a informação adicional estará ativa ou inativa. Tabela E

Estrutura de Json  


    
{
	"AdditionalInfo": {
		"type": 1,
		"name": "Time do coração?",
		"display_value": 1,
		"required": 1,
		"add_total": 1,
		"max_length": 12,
		"value": "11.90",
		"active": 1
	}
}
    

Retorno em caso de sucesso (status code 200 ou 201) 

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

id do AdditionalInfo

code Number

Código do retorno (201)

Json de retorno 

HTTP/1.1201 OK

{
    "message": "Created",
    "id": "17",
    "code": 201
}

 

2 - Atualizar as informações adicionais relacionadas ao PRODUTO.

Método PUT

https://{api_address}/products/:id(do_produto)/additional_info/?access_token={token}

Parâmetros enviados 

Campo Tipo (Tamanho) Descrição
access_token String

Chave de acesso

AdditionalInfo String

Informações adicionais do produto

info_id String

id da informação adicional gerada

inherit_deadline Number

Se herdará o prazo a ser inserido no frete. Tabela F

deadline Number

prazo que será adicionado ao frete caso seja será necessário para preparação da personalização ao produto

order Number

Ordem de exibição da informação adicional na loja virtual

Estrutura de Json 


    
{
    "AdditionalInfo": {
        "info_id": 17,
        "inherit_deadline": 1,
        "deadline": 3,
        "order": 1
    }
}

    

Retorno em caso de sucesso (status code 200 ou 201)

Campo Tipo Descrição
message String

Mensagem de retorno

code Number

Código do retorno (200)

 

Json de retorno

HTTP/1.1201 OK

{
    "message": "Created",
    "code": 201
}

Tabelas Auxiliares

Tabelas Auxiliares de Informações Adicionais (additional_info)

Tabela A - Correspondo a forma como será exibida a informação adicional (campo type)

Valor Descrição
0 Linha de texto (input text)
1 Caixa de seleção (select)
2 Caixa de Texto (textarea)

Tabela B - Se o valor será exibido (campo display_value)

Valor Descrição
0 não exibir valor
1 exibir valor

Tabela C - Se será obrigatório ou não no momento da compra (campo required)

Valor Descrição
0 não é obrigatório
1 obrigatório

Tabela D - Se o valor será somado ou não ao produto (campo add_total)

Valor Descrição
0 não somar com o valor do preço do produto
1 somar com o total do preço do produto

Tabela E - Se a informação adicional estará ativa ou inativa (campo active)

Valor Descrição
0 inativa
1 ativa

Tabela F - Se herdará o prazo a ser inserido no frete (campo inherit_deadline)

Valor Descrição
0 não herdar prazo
1 herdar prazo

 

Consultar - additional_info

Requisição para a consultar dados da additional_info.

1 - LISTAGEM GERAL DAS INFORMAÇÕES ADICIONAIS

Método GET

https://{api_address}/additional_info/?access_token={token}

Código de Exemplo

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

    $url = "https://{api_address}/additional_info/?".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}/additional_info/";

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}/additional_info/";

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âmetros enviados 

Campo Tipo (Tamanho) Descrição
  access_token String

Chave de acesso

  AdditionalInfo JSON

Informações adicionais do produto

  Id String

Id da AdditionalInfo

  type String

Corresponde ao tipo de exibição da informação adicional. Tabela A

 display_as String

Corresponde a forma como será exibida a informação adicional.

  name String

Nome da informação adicional

  display_value Number

Se o valor será exibido. Tabela B

  required Number

Se será obrigatório ou não no momento da compra. Tabela C

  add_total Number

Se o valor será somado ou não ao produto. Tabela D

  max_length Number

Corresponde a quantidade de caracter que poderá ser inserido na informação adicional. Exemplo: Camisa de torcedor (possuirá dois dígitos)

  value Decimal

Valor do produto que estiver setado com a informação adicional

  active Number

Se a informação adicional estará ativa ou inativa. Tabela E

Json de retorno

HTTP/1.1201 OK

{
    "paging": {
        "total": 3,
        "page": 1,
        "offset": 0,
        "limit": 30,
        "maxLimit": 50
    },
    "sort": [
        {
            "id": "asc"
        }
    ],
    "availableFilters": [
        "id",
        "type",
        "name",
        "display_value",
        "required",
        "add_total",
        "active",
        "order",
        "display_as",
        "max_length",
        "value",
        "height"
    ],
    "appliedFilters": [],
    "AdditionalInfos": [
        {
            "AdditionalInfo": {
                "id": "5",
                "type": "imput text",
                "name": "Time do coração?",
                "display_value": 0,
                "required": 0,
                "add_total": 0,
                "max_length": 0,
                "value": "1",
                "active": 1
            }
        },
        {
            "AdditionalInfo": {
                "id": "31",
                "type": "textarea",
                "name": "Time do coração?",
                "display_value": 1,
                "required": 1,
                "add_total": 1,
                "max_length": 12,
                "value": 11.9,
                "active": 1,
                "height": 0
            }
        },
        {
            "AdditionalInfo": {
                "id": "33",
                "type": "select",
                "display_as": "select",
                "name": "Time do coração?",
                "display_value": 1,
                "required": 1,
                "add_total": 1,
                "active": 1
            }
        }
    ]
}

1.1 - CONSULTAR DADOS DAS INFORMAÇÕES ADICIONAIS

Método GET

https://{api_address}/additional_info/:id(additional_info)/?access_token={token}

Parâmetros enviados 

Campo Tipo (Tamanho) Descrição
  access_token String

Chave de acesso

  AdditionalInfo JSON

Informações adicionais do produto

  Id String

Id da AdditionalInfo

  type String

Corresponde ao tipo de exibição da informação adicional. Tabela A

 display_as String

Corresponde a forma como será exibida a informação adicional.

  name String

Nome da informação adicional

  display_value Number

Se o valor será exibido. Tabela B

  required Number

Se será obrigatório ou não no momento da compra. Tabela C

  add_total Number

Se o valor será somado ou não ao produto. Tabela D

  max_length Number

Corresponde a quantidade de caracter que poderá ser inserido na informação adicional. Exemplo: Camisa de torcedor (possuirá dois dígitos)

  value Decimal

Valor do produto que estiver setado com a informação adicional

  active Number

Se a informação adicional estará ativa ou inativa. Tabela E

Json de retorno

HTTP/1.1201 OK

{
    "AdditionalInfo": {
        "id": "33",
        "type": "select",
        "display_as": "select",
        "name": "Time do coração?",
        "display_value": "1",
        "required": "1",
        "add_total": "1",
        "active": "1"
    }
}

Tabelas Auxiliares

Tabelas Auxiliares de Informações Adicionais (additional_info)

Tabela A - Correspondo a forma como será exibida a informação adicional (campo type)

Valor Descrição
0 Linha de texto (input text)
1 Caixa de seleção (select)
2 Caixa de Texto (textarea)

Tabela B - Se o valor será exibido (campo display_value)

Valor Descrição
0 não exibir valor
1 exibir valor

Tabela C - Se será obrigatório ou não no momento da compra (campo required)

Valor Descrição
0 não é obrigatório
1 obrigatório

Tabela D - Se o valor será somado ou não ao produto (campo add_total)

Valor Descrição
0 não somar com o valor do preço do produto
1 somar com o total do preço do produto

Tabela E - Se a informação adicional estará ativa ou inativa (campo active)

Valor Descrição
0 inativa
1 ativa

 

Cadastrar - additional_info

Requisição para cadastrar informação adicional. É possível inserir as Informações Adicionais ao Produto, via API.

Para acrescentar informações, além da descrição, sobre os seus produtos, você tem a opção de cadastrar as informações adicionais.

Método POST

https://{api_address}/additional_info/?access_token={token}

Código de Exemplo

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

    $data["AdditionalInfo"]["type"] = 1;
    $data["AdditionalInfo"]["name"] = "Time do coração?";
    $data["AdditionalInfo"]["display_value"] = 1;
    $data["AdditionalInfo"]["required"] = 1;
    $data["AdditionalInfo"]["add_total"] = 1;
    $data["AdditionalInfo"]["max_length"] = 12;
    $data["AdditionalInfo"]["value"] = 11.90;
    $data["AdditionalInfo"]["active"] = 1;

    $url = "https://{api_address}/additional_info?".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 == "201"){
        //Tratamento dos dados de resposta da consulta.
    }else{
        //Tratamento das mensagens de erro
    }
?>

string URLAuth = "https://{api_address}/additional_info";

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 += "  \"AdditionalInfo\": {";
       postString += "      \"type\": 1,";
       postString += "      \"name\": \"Time do coração?\",";
       postString += "      \"display_value\": \"1\",";
       postString += "      \"required\": \"1\",";
       postString += "      \"add_total\": \"1\",";
       postString += "      \"max_length\": \"12\",";
       postString += "      \"value\": \"11.90\",";
       postString += "      \"active\": 1,";
       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}/additional_info";
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 += "  \"AdditionalInfo\": {";
           postString += "      \"type\": 1,";
           postString += "      \"name\": \"Time do coração?\",";
           postString += "      \"display_value\": \"1\",";
           postString += "      \"required\": \"1\",";
           postString += "      \"add_total\": \"1\",";
           postString += "      \"max_length\": \"12\",";
           postString += "      \"value\": \"11.90\",";
           postString += "      \"active\": 1,";
           postString += "  }";
           postString += "}";
           
    // Send post 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 && responseCode < 300){
        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
}
String resposta = response.toString();

1 - Criar uma informação adicional, por meio do POST.

Parâmetros enviados 

Campo Tipo (Tamanho) Descrição
  access_token String

Chave de acesso

  AdditionalInfo JSON

Informações adicionais do produto

  type String

Correspondo a forma como será exibida a informação adicional. Tabela A

  name String

Nome da informação adicional

  display_value Number

Se o valor será exibido. Tabela B

  required Number

Se será obrigatório ou não no momento da compra. Tabela C

  add_total Number

Se o valor será somado ou não ao produto. Tabela D

  max_length Number

Corresponde a quantidade de caracter que poderá ser inserido na informação adicional. Exemplo: Camisa de torcedor (possuirá dois dígitos)

  value Decimal

Valor do produto que estiver setado com a informação adicional

  active Number

Se a informação adicional estará ativa ou inativa. Tabela E

Estrutura de Json  


    
{
	"AdditionalInfo": {
		"type": 1,
		"name": "Time do coração?",
		"display_value": 1,
		"required": 1,
		"add_total": 1,
		"max_length": 12,
		"value": "11.90",
		"active": 1
	}
}
    

Retorno em caso de sucesso (status code 200 ou 201) 

Campo Tipo Descrição
message String

Mensagem de retorno

id Number

id do AdditionalInfo

code Number

Código do retorno (201)

Json de retorno 

HTTP/1.1201 OK

{
    "message": "Created",
    "id": "17",
    "code": 201
}

1.1 HAVERÁ UMA DIFERENÇA NO ENVIO DO JSON, QUANDO O TIPO ESCOLHIDO FOR 1 ("type": 1,). Segue abaixo:

Estrutura de Json  


{
    "AdditionalInfo": {
        "type": 1,
        "name": "Time do coração?",
        "display_value": 1,
        "required": 1,
        "add_total": 1,
        "max_length": 12,
        "value": "11.90",
        "active": 1,
        "options": [
            {
                "name": "São Paulo",
                "value": "15.00"
            },
            {
                "name": "Vasco",
                "value": "30.00"
            }
        ]
    }
}
    

UTILIZANDO OS SEGUINTES PARÂMETROS ENVIADOS:

Campo Tipo (Tamanho) Descrição
  access_token String

Chave de acesso

  AdditionalInfo JSON

Informações adicionais do produto

  type String

Correspondo a forma como será exibida a informação adicional. Tabela A

  name String

Nome da informação adicional

  display_value Number

Se o valor será exibido. Tabela B

  required Number

Se será obrigatório ou não no momento da compra. Tabela C

  add_total Number

Se o valor será somado ou não ao produto. Tabela D

  max_length Number

Corresponde a quantidade de caracter que poderá ser inserido na informação adicional. Exemplo: Camisa de torcedor (possuirá dois dígitos)

  value Decimal

Valor do produto que estiver setado com a informação adicional

  active Number

Se a informação adicional estará ativa ou inativa. Tabela E

  options Array

Opções do select

  name String

Nome da opção a ser selecionada

  value String

Valor da opção a ser selecionada

 

2 - Vincular a informação adicional ao produto, por meio do POST.

Método POST

https://{api_address}/products/:id(do_produto)/additional_info/?access_token={token}

Parâmetros enviados 

Campo Tipo (Tamanho) Descrição
access_token String

Chave de acesso

AdditionalInfo String

Informações adicionais do produto

info_id String

id da informação adicional gerada

inherit_deadline Number

Se herdará o prazo a ser inserido no frete. Tabela F

deadline Number

prazo que será adicionado ao frete, caso seja necessário para preparação da personalização do produto

order Number

Ordem de exibição da informação adicional na loja virtual

Estrutura de Json 


    
{
    "AdditionalInfo": {
        "info_id": 17,
        "inherit_deadline": 1,
        "deadline": 3,
        "order": 1
    }
}

    

Retorno em caso de sucesso (status code 200 ou 201)

Campo Tipo Descrição
message String

Mensagem de retorno

code Number

Código do retorno (200)

 

Json de retorno

HTTP/1.1201 OK

{
    "message": "Created",
    "code": 201
}

Tabelas Auxiliares

Tabelas Auxiliares de Informações Adicionais (additional_info)

Tabela A - Correspondo a forma como será exibida a informação adicional (campo type)

Valor Descrição
0 Linha de texto (input text)
1 Caixa de seleção (select)
2 Caixa de Texto (textarea)

Tabela B - Se o valor será exibido (campo display_value)

Valor Descrição
0 não exibir valor
1 exibir valor

Tabela C - Se será obrigatório ou não no momento da compra (campo required)

Valor Descrição
0 não é obrigatório
1 obrigatório

Tabela D - Se o valor será somado ou não ao produto (campo add_total)

Valor Descrição
0 não somar com o valor do preço do produto
1 somar com o total do preço do produto

Tabela E - Se a informação adicional estará ativa ou inativa (campo active)

Valor Descrição
0 inativa
1 ativa

Tabela F - Se herdará o prazo a ser inserido no frete (campo inherit_deadline)

Valor Descrição
0 não herdar prazo
1 herdar prazo

 

Delet - additional_info

Requisição para excluir uma informação adicional.

EXCLUIR INFORMAÇÃO ADICIONAL RELACIONADA AO PRODUTO

  Método DELETE

https://{api_address}/products/:id(do_produto)/additional_info/:id(additional_info)/?access_token={token}

Código de Exemplo


 

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

    $url = "https://{api_address}/products/:id(do_produto)/additional_info/:id(additional_info)?".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/:id(do_produto)/additional_info/:id(additional_info)";

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/:id(do_produto)/additional_info/:id(additional_info)";
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
}
String resposta = response.toString();

Parâmetros enviados

Campo Tipo Descrição
access_token String

Chave de acesso

Retorno em caso de sucesso (status code 200 ou 201)

Campo Tipo Descrição
message String

Deleted

code Number

Código do retorno (200)

Json de retorno

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

EXCLUIR INFORMAÇÃO ADICIONAL

  Método DELETE

https://{api_address}/additional_info/:id(additional_info)/?access_token={token}

Parâmetros enviados

Campo Tipo Descrição
access_token String

Chave de acesso

Retorno em caso de sucesso (status code 200 ou 201)

Campo Tipo Descrição
message String

Deleted

id Number

id da informação adicional

code Number

Código do retorno (200)

Json de retorno

HTTP/1.1 200 OK
{
    "message": "Deleted",
    "id": "35",
    "code": 200
}
Bruna Lourencini 
Tem mais dúvidas? Envie uma solicitação

Comentários

    Artigos nessa seção

    Powered by Zendesk