Como Integrar

As APIs de Integração é um serviço formecido pela Tray para que nossos clientes possam integrar seus softwares a nossa plataforma.

Ambiente de Teste

Não possuimos um ambiente especifico para teste, para esse fim, disponibilizamos uma loja compartilhada entre todos os integradores.

O usuário e senha da loja de testes será gerado junto com as chaves e enviados em conjunto no processo de homologação.

Nossas Integrações

A integração com a Tray é feita através das Nossas APIs no padrão REST, o que possibilita manipular os clientes, produtos e até os pedidos da loja virtual. Atualmente estão disponíveis as APIs:

• Autorização
• Características
• Carrinho de Compra
• Categorias
• Clientes
• Cupom
• Emissores de Etiquetas
• Etiqueta Mercado Livre
• informações Adicionais
• Informações da Loja
• Informações de Pagamentos
• Integração de Fretes
• Kits
• Lista de Preços B2B
• Marca de Produtos
• Newsletter
• Nota Fiscal
• Páginas da Loja
• Palavras-Chave
• Parceiros
• Pedidos
• Produtos
• Produtos Vendidos
• Scripts Externos
• Sistema de Notificação Webhook
• Status de Pedido
• Variação de Produtos

Para utilizar as APIs é necessário criar seu aplicativo e, após este cadastro, são liberadas as chaves para a integração.

Temos disponível para parceiros nossa Loja de Aplicativos, onde nossos lojistas conseguem localizar e fazer a instalação de forma simples e rápida e já integrar com a sua aplicação.

Desta forma, é possível integrar desde um sistema de gestão empresarial (ERP) ou sistemas próprios para melhorar a experiência do consumidor.

Também disponibilizamos a integração com o sistema de Gateway de Frete, caso precise personalizar o calculo de frete através de alguma transportadora.

Criando seu Aplicativo

Para disponibilizar as chaves de integração é necessário realizar dois processos:

• Realizar o credenciamento
• Informar os dados para a criação de uma aplicação.

Para o credenciamento é necessário contato com nossa equipe de parcerias através do formulário de contato.

Segue abaixo link do formulário para contato:

https://www.tray.com.br/parceiros/quero-ser-parceiro/

Após o credenciamento, será necessário informar os dados do aplicativo para cadastro. Estes dados são divididos em dados do integrador, onde é necessário informar os dados da empresa que irá realizar a integração, e dados do aplicativo, com os dados para cadastro da aplicação. Segue abaixo os dados necessários:

Dados do Aplicativo:

• Nome do aplicativo
• Descrição simplificada do aplicativo
• Imagem com o logo da aplicação
• Descrição completa do aplicativo
• URL de callback, em ambiente seguro - SSL (URL utilizada para realizar a autorização da aplicação)
• ID da Loja
• Link do vídeo (Youtube)
• URLs de imagens (máximo 3)

Dados do integrador:

• Nome da empresa
• Telefone
• E-mail
• Site
• Nome do Responsável Técnico (Desenvolvedor)
• E-mail do Responsável Técnico (Desenvolvedor)

Após o cadastro da aplicação são disponibilizadas as chaves Consumer Key e Consumer Secret necessárias para a autorização do aplicativo e geração das chaves de acesso.

OBS: Todas as solicitações serão analisadas, onde poderão ser aprovadas ou rejeitadas devido solicitação indevida, ausência de informações ou solicitação de parceiro ou desenvolvedor não credenciado.

Quantidade de Requisições

As requisições tem um limite de envio, onde são diferenciadas de duas formas.

1 - Quantidade de requisições de curto espaço de tempo, limitado em 180 requisições por minuto.

2 - Quantidade de requisições diárias, limitado em 10 mil requisições diárias por loja, sendo um limite de 50 mil requisições por dia em caso de loja corporativa.

Autorizando seu Aplicativo

A autenticação via oAuth 2.0 é necessário para acesso as informações da API e Aplicativos de Terceiro.

Abaixo a sequência de autenticação:

O código de autorização é fornecido através do servidor de autenticação do Tray.

Para permitir acesso as informações e recursos da conta, o cliente deve ser redirecionado para a url de autenticação pelo navegador.

O Tray Commerce é responsável por receber a confirmação da autorização do cliente e fornecer o código de autorização ao aplicativo.

Url para autenticação:

https://{dominio_da_loja}/auth.php

Parâmetros HTTP "GET" suportados para a autenticação:

Exemplo da url:

https://{dominio_da_loja}/auth.php?response_type=code&consumer_key={consumer_key}&callback=https://{url_de_callback}

Obs. trocar os dados que estão dentro de chaves { } para os dados da loja e do aplicativo.

Obs. A url de callback deve fazer o uso do certificado digital(HTTPS)/SSL

Fluxo de autorização

O aplicativo é acessado dentro da área administrativa da loja no menu Meus aplicativos. Após o acesso a este menu, terá disponível o botão Instalar novos aplicativos, onde os clientes poderão localizar a aplicação para instalação na loja.

Ao instalar uma aplicação, será realizado o redirecionamento para a URL de Callback informada no momento do cadastro do aplicativo, abrindo por exemplo a página http://{dominiodoapp}/tray/callback em um iframe, dentro da área administrativa da loja.

Neste ponto a platforma irá enviar os seguintes parâmetros pela url:

array(3) { ["url"]=> string(42) "https://trayparceiros.commercesuite.com.br" ["adm_user"]=> string(8) "roottray" ["store"]=> string(6) "391250" }

Você deverá implementar nesta URL http://{dominiodoapp}/tray/callback, uma Landing Page apresentando os detalhes do aplicativo e disponibilizar um botão para o cliente solicitando a integração com a aplicação. Geralmente este botão tem o titulo de Instale agora ou Inicie agora.

Neste botão você irá direcionar o cliente para a URL de autorização da loja, onde esta URL ficaria:

http://{URL da loja}/auth.php?response_type=code&consumer_key=**CONSUMER_KEY**&callback=http://{dominiodoapp}/tray/callback/auth/

Quando direcionado o cliente para essa pagina, irá aparecer uma tela solicitando a autorização da aplicação, conforme abaixo:

Uma observação importante é que, após autorizado, não será mais exibida essa tela, já passando automaticamente para o fluxo abaixo.

Neste ponto a plataforma irá enviar os seguintes parâmetros na url:

array(5) { ["adm_user"]=> string(8) "roottray" ["code"]=> string(64) "48f72c09305060f12b894193aaba2962989f00637012b8fa92b9d657e5a297f7" ["api_address"]=> string(50) "https://trayparceiros.commercesuite.com.br/web_api" ["store"]=> string(6) "391250" ["store_host"]=> string(42) "https://trayparceiros.commercesuite.com.br" }

Após a autorização, o cliente é redirecionado para URL informada no parâmetro callback passado no momento da autorização (no exemplo acima é a URL http://{dominiodoapp}/tray/callback/auth/), onde ficará da seguinte forma esta URL:

http://{dominiodoapp}/tray/callback/auth/?code=2132112312321313abc123edf&store=391250&api_address=http://{URL da loja}/web_api/

Neste processo deve-se capturar as informações dessa URL e utilizá-las para configurar em sua aplicação, sendo os parâmetros code e api_address mais importantes no processo de integração.

Com o code e api_address é possível utilizar a API de Gerar Chave de Acesso, para gerar o access_token utilizados nas outras APIs. É de extrema importância armazenar todas as informações de retorno desta API, pois serão utilizados constantemente durante a comunicação com a Tray.

Pode-se notar que no retorno da API de Gerar Chave de Acesso existe a expiração dessas chaves e, quando expirado, deverá utilizar a API de Atualizar Chave de Acesso, onde será gerada um novo access_token para continuar realizando requisições nas APIs.

Dessa forma, toda referência que encontrar na documentação de api_address deverá ser utilizada a URL retornada no momento da autorização da API, conforme informado acima, e utilizar o access_token gerado para não ocorrer problema de permissão de acesso aos dados.

Dúvidas e Suporte

Para dúvidas relacionadas ao consumo das APIs disponibilizadas pedimos que abra um chamado diretamente através da nossa central de atendimento.

Autorização

Gerar Chaves de Acesso#post

api_address: "www.urldaloja.com.br/web_api"

curl --location -g --request POST '{{api_address}}/auth' \
--data-urlencode 'consumer_key={{consumer_key}}' \
--data-urlencode 'consumer_secret={{consumer_secret}}' \
--data-urlencode 'code={{code}}'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{api_address}}/auth');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->addPostParameter(array(
  'consumer_key' => '{{consumer_key}}',
  'consumer_secret' => '{{consumer_secret}}',
  'code' => '{{code}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("{{api_address}}/auth");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("consumer_key", "{{consumer_key}}");
request.AddParameter("consumer_secret", "{{consumer_secret}}");
request.AddParameter("code", "{{code}}");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "consumer_key={{consumer_key}}&consumer_secret={{consumer_secret}}&code={{code}}");
Request request = new Request.Builder()
  .url("{{api_address}}/auth")
  .method("POST", body)
  .build();
Response response = client.newCall(request).execute();

A Chave de Acesso é a crêdencial utilizada para acessar os recursos protegidos do cliente.

Essa chave representa a autorização emitida pelo cliente no servidor de autorização do Tray Commerce.

Somente é possível gerar a Chave de Acesso utilizando as chaves disponibilizados para o aplicativo (consumer key e consumer secret) e o código de autorização (code) que é resgatado após a instalação do aplicativo na loja, então será realizada esta requisição para a API de Gerar Chave de Acesso.

As chaves consumer_key e consumer_secret, são únicas para cada aplicativo. E serão enviadas por e-mail após o setor de Parcerias liberarem o cadastro do aplicativo. Quero Ser Parceiro

A chave code é única para cada loja. E pode ser obtida depois de instalar o aplicativo na loja.

Onde você encontra o code dentro da loja:

1-Vá até meus aplicativos

2-Clique sobre instalar novo aplicativos

3-Procure pelo seu aplicativo

4-Acessando o painel da loja na opção: Meus Aplicativos.

Procure pelo aplicativo e clique sobre acessar , onde será exibido o code!!

Método POST

https://{api_address}/auth

Dados para ser enviados no corpo da requisição:

Exemplo de retorno:

  {
    "message": "Created tokens",
    "code": "200",
    "access_token": "APP_ID-9999-4c78abce105a578987987987987987asdasd4c14ec98eeca880dc9aa76ed118372ae4",
    "refresh_token": "86188asd456asd456asd9c192721dbdc03851a791a9cd6d3568a0dcb6a87080e229",
    "date_expiration_access_token": "2021-03-02 14:58:21",
    "date_expiration_refresh_token": "2021-04-01 11:58:21",
    "date_activated": "2021-03-02 11:58:21",
    "api_host": "https://urldaloja.com.br/web_api",
    "store_id": "123456"
  }

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

Error code:

Atualizar Chave de Acesso#get

Método GET

api_address: "urldaloja.com.br/web_api"

curl --location -g --request GET '{{api_address}}/auth?refresh_token={{refresh_token}}'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{api_address}}/auth?refresh_token={{refresh_token}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("{{api_address}}/auth?refresh_token={{refresh_token}}");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("{{api_address}}/auth?refresh_token={{refresh_token}}")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

https://{api_address}/auth

Parâmetros enviados:

Exemplo de retorno:

  {
    "message": "Refreshed tokens",
    "code": "200",
    "access_token": "APP_ID-9999-4c78abce105a578987987987987987asdasd4c14ec98eeca880dc9aa76ed118372ae4",
    "refresh_token": "86188asd456asd456asd9c192721dbdc03851a791a9cd6d3568a0dcb6a87080e229",
    "date_expiration_access_token": "2021-03-02 14:58:21",
    "date_expiration_refresh_token": "2021-04-01 11:58:21",
    "date_activated": "2021-03-02 11:58:21",
    "api_host": "https://urldaloja.com.br/web_api",
    "store_id": "123456"
  }

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

Homologação do aplicativo

Validação em Loja de teste

O processo de desenvolvimento e homologação irá ocorrer em loja de teste compartilhada, para que seja realizado as validações referente a requisição, seguir toda orientação da documentação .

Requisito para homologação e liberação para produção

• Enviar as evidencias das requisições utilizadas na aplicação (URL, JSON e Retorno) conforme a documentação enviada após o preenchimento do formulário quero ser parceiro

• Ter preenchido o formulário quero ser parceiro

• Ter feito todas requisições na loja de teste

Canal de atendimento para homologacão

Realizar a abertura do chamado no link a baixo, com o seguinte título "Homologacao Nome do aplicativo", eviando para nos as evidencias da requisição, conforme solicitado no requisito para homologação

Link para homologação:

Clique aqui para realizar a homologação

OBS: Caso o aplicativo consuma menos que 2 POST e 2 PUT em 2 recursos, será necessário realizar algumas requisições, via POSTMAN ou INSOMNIA + o requisito da aplicação.

Liberar o aplicativo para loja (PONTUAL)

Caso o aplicativo seja pontual ou seja para lojas específicas, peço que realize a abertura de um chamado no link abaixo, solicitando a liberação do aplicativo !!

Obs. Para liberar o aplicativo para uma ou mais lojas o aplicativo DEVE ter passado pelo processo de homologação, caso o aplicativo seja para toda base, ele será exido no momento da instação em meus aplicativos

Clique aqui para solicitar a liberação do app

APIs de Sistema de Notificação(Webhook)

API DE SISTEMA DE NOTIFICAÇÃO (WEBHOOK)

Documentação – Sistema de Notificações

A Tray disponibiliza atualmente o sistema de Webhook, que possui a finalidade de agregar agilidade no fluxo das APIs.

Exemplo de caso: se a loja possui 1000 pedidos e foram alterados 50 pedidos e criados mais 50, ao invés do Integrador reprocessar todos os mil pedidos, com o webhook informando quais ids de pedidos foram alterados/criados, você irá consultar apenas 100 pedidos.

Ativação da Notificação:

Para ativar as notificações, é necessário informar uma URL de Notificação, onde será cadastrada em seu aplicativo que já esteja credenciado junto a Tray.

Sendo assim, favor abrir um chamado através deste link: https://atendimento.tray.com.br/hc/pt-br/requests/new e em: Precisa de ajuda com sua loja virtual? escolher o escopo: "TRAY DESENVOLVEDORES" > "INTEGRAÇÕES API" e informar o nome do aplicativo e url de notificação para iniciar o processo de ativação.

Funcionalidade:

A Tray irá realizar o envio dos parâmetros (scope_name | scope_id | seller_id | act) via POST, para a url de notificação cadastrada no aplicativo.

Esta url deverá estar disponível, para receber os parâmetros que a Tray vai enviar.

No caso, a url de notificação deve ser uma url externa preparada para receber requisições via POST, ou seja, deve ser disponibilizada de forma externa e deve conseguir interpretar as notificações enviadas pela Tray.

Notificações:

Estas notificações serão realizadas para uma URL do aplicativo, através de uma requisição via POST, onde o aplicativo irá receber essas notificações quando ocorrer alguma inserção, atualização ou exclusão de informações na plataforma, referente ao escopo que estiver habilitado, para o recebimento dessas notificações.

Atualmente, a notificações dos escopos só ocorrem a partir de novas ações, ou seja, começaram a ser notificados a partir do momento em que o aplicativo aderiu ao sistema de Webhook, desse momento em diante, qualquer ação nova será notificada.

Não será notificado nenhum escopo do qual já tenha ocorrido uma ação passada, antes de aderir ao sistema de notificação.

Dessa forma, para ter acesso as informações que ocorreram antes de aderir as notificações do Webhook, será necessário consultar diretamente as APIs respectivas, em que deseja saber.

Tempo de Notificação:

O tempo do envio das notificações da Tray para a url de notificação, ocorre em questão de minutos, sendo enviadas no mesmo instante.

É possível, por uma questão pontual, ocorrer um atraso no processo do envio.

O processo do envio das notificações podem ocorrem da seguinte forma:

A Tray realiza o primeiro envio das informações para a url de notificação, se houver alguma falha em sua url neste recebimento, a Tray irá realizar um segundo envio das informações, no entanto, se no primeiro envio, ocorreu em questão de minutos, o segundo envio irá ocorrer dentro de meio hora, e assim se sucederá aumentando o espaçamento do envio, até que a Tray consiga realizar os envios de todas as informações necessárias para a url de notificação.

Dessa forma é necessário que a url de notificação sempre esteja disponível e livre de impedimentos para receber as notificações da Tray, pois caso ocorra uma tentativa excessiva e impacte nosso banco, ficará passível do nosso time de infra, bloquear o serviço. E não, não conseguimos informar qual é o limite máximo das retentativas, pois tudo irá depender do processamento interno de nossa fila.

Recomendações de Implementação:

São recomendados dois tratamentos para utilização do sistem de notificação que são, armazenar as notificações e agrupar as notificações idênticas antes de gerar qualquer ação.

Desta forma, pode-se evitar diversas requisições ao mesmo escopo, visto que um produto pode sofrer diversas atualizações em um curto interválo de tempo, assim como o pedido pode sofrer alterações rápidas.

Exemplo de envio do payload:

Segue exemplo abaixo de payload, sobre o que é enviado via POST da Tray para a url do Webhook, dessa forma, é necessário realizar a captura dessas informações via código e então implementar as configurações dentro do sistema, de acordo com a necessidade do aplicativo.

OBS: O formato utilizado no payload é x-www-form-urlencoded

{ "seller_id"=>391250, "scope_id"=>4375797, "scope_name"=>"order", "act"=>"update", "app_code"=>"718", "url_notification"=>"https://suaurldenotificacao" }

É possível habilitar o webhook para lojas específicas ou desabilitar de lojas específicas?

Não. Atualmente o serviço disponibilizado atua sobre o aplicativo e não sobre as lojas, ou seja, qualquer loja integrada ao app, o Integrador receberá as notificações das mesmas, sendo assim, para não receber as notificações de determinada loja, somente realizando a desinstalação do app dentro dessa loja.

É possível receber outros tipos de notificações, conforme demostrando no exemplo do playload?

Não. Atualmente não é possível. Caso deseje receber outros tipos de notificações, você poderá enviar uma solicitação para o nosso canal de SUGESTÕES.

Segue o link: https://clientes.tray.com.br/sugestao-tray/

Exclusão do serviço em caso de desinstalação do aplicativo?

(será o mesmo comportamento para troca de url de notificação)

Por um período de 20 dias, é provável que sua url ainda receba notificações da loja que realizou a desinstalação do seu aplicativo, pois o nosso sistema irá realizar a tentativa de entregas das notificações pendentes, até o momento em que o app foi desinstalado. Sendo assim, enquanto nosso sistema receber o status do HTTP da URL diferente de 200, continuaremos enviando diversas retentativas de envio das notificações até que esse esse resíduo de notificações retorne com o HTTP Code 200, o que poderá perdurar por aproximadamente 20 dias.

Parâmetros da Notificação

Para identificar o tipo de dado e qual a informação que foi atualizada, são enviados alguns parâmetros via POST no momento da notificação. Esses parâmetros são:

Abaixo os escopos disponíveis na notificação:

Lembrando que, inicialmente realizamos a liberação somente do escopo de "PEDIDOS", caso deseje realizar a liberação dos demais escopos, ou até mesmo de todos eles, isso deverá ser informado via chamado, no momento do envio da url.

Exemplo de código:

php
    $sellerID = $_POST["seller_id"]; //Código da Loja

    switch($_POST["scope_name"] . "_" . $_POST["act"] ){
        case "product_insert":
            // Tratamento da atualização produto
            $productID = $_POST["scope_id"]; // Código do produto
        break;
        case "product_update":
            // Tratamento da atualização do produto
            $productID = $_POST["scope_id"]; // Código do produto
        case "variant_stock_update":
            // Tratamento da atualização de estoque de uma variação de produto
            $variantID = $_POST["scope_id"]; // Código da variação do produto
        break;
        case "order_insert":
            // Tratamento da insersão de um novo pedido
            $orderID = $_POST["scope_id"]; // Código do pedido
        break;
        case "customer_delete":
            // Tratamento da exclusão de um cliente
            $customerID = $_POST["scope_id"]; // Código do cliente
        break;
    }

As ações disponíveis na notificação são localizadas abaixo:

API de Produtos

Listagem de Produtos#get

Requisição para a consulta de uma lista produtos.

Método GET

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

Parâmetros enviados

Retorno da API

Retorno de Invalid or expired token (401)

Obs: Chave inválida ou expirada, ocorre quando o access_token está expirado ou o seu valor está incorreto no parâmetro da url, pedimos que consuma à API abaixo para realizar a renovação ou geração da chave de acesso Clique aqui.

Retorno de Not Found e No records found (404)

Obs: O response code 404 é ocasionado quando há um erro de sintaxe na url da requisição ou quando não encontramos id passado por parâmetro na URL.

Retorno de Method Not Allowed (405)

Obs: Para o respose 405, pedimos que seja verificado se o tipo de atributo o qual está sendo enviado, é igual ao tipo de atributo o qual está na documentação.

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

Exemplo de retorno:

{
    "paging": {
        "total": 108,
        "page": 1,
        "offset": 0,
        "limit": 30,
        "maxLimit": 50
    },
    "sort": [
        {
            "id": "asc"
        }
    ],
    "availableFilters": [
        "id",
        "name",
        "category_id",
        "ean",
        "available",
        "price",
        "brand",
        "model",
        "hot",
        "quantity_sold",
        "release",
        "free_shipping",
        "weight",
        "image",
        "release_date",
        "stock",
        "promotion",
        "reference",
        "has_buy_together",
        "has_free_gift",
        "has_description",
        "brand_id",
        "additional_button",
        "virtual_product",
        "has_ean",
        "is_kit",
        "has_title",
        "has_meta_description",
        "has_keywords",
        "has_variations",
        "has_brand",
        "has_model",
        "has_dimension",
        "has_weight",
        "property_name",
        "property_id",
        "property_value",
        "property_value_id",
        "activation_date",
        "deactivation_date",
        "show_properties",
        "kit_has_variation",
        "modified",
        "created",
        "price_range",
        "current_price_range",
        "date_range",
        "date_range_deactivation",
        "current_price"
    ],
    "appliedFilters": [],
    "Products": [
        {
            "Product": {
                "modified": "2018-12-26 13:46:12",
                "ean": "",
                "is_kit": "0",
                "slug": "produto-teste",
                "ncm": "0",
                "activation_date": "0000-00-00",
                "deactivation_date": "0000-00-00",
                "id": "0",
                "name": "PRODUTO TESTE",
                "price": "139.00",
                "cost_price": "0.00",
                "dollar_cost_price": "0.00",
                "promotional_price": "0.00",
                "start_promotion": "0000-00-00",
                "end_promotion": "0000-00-00",
                "brand": "",
                "brand_id": "",
                "model": "",
                "weight": "958",
                "length": "0",
                "width": "0",
                "height": "0",
                "stock": "51",
                "category_id": "25",
                "available": "1",
                "availability": "",
                "reference": "016301",
                "hot": "0",
                "release": "0",
                "additional_button": "0",
                "has_variation": "0",
                "rating": "0",
                "count_rating": "0",
                "quantity_sold": "0",
                "url": {
                    "http": "http://{dominio_da_loja}/categoria/produto-de-teste",
                    "https": "https://{dominio_da_loja}/categoria/produto-de-teste"
                },
                "created": "2016-10-19 09:30:12",
                "Properties": [],
                "payment_option": "R$ 125,10 à vista com desconto Boleto - Yapay ou 12x de R$ 13,14 com juros",
                "payment_option_details": [
                    {
                        "display_name": "Boleto - Yapay",
                        "type": "bank_billet",
                        "plots": "1",
                        "value": "125.10",
                        "tax": "0.00"
                    },
                    {
                        "display_name": "Cartão MasterCard - Yapay",
                        "type": "credit_card",
                        "plots": "12",
                        "value": "13.14",
                        "tax": "1.99"
                    }
                ],
                "related_categories": [],
                "release_date": "2016-12-21",
                "shortcut": "produto-test",
                "virtual_product": "",
                "minimum_stock": "0",
                "minimum_stock_alert": "0",
                "free_shipping": "0",
                "video": "",
                "metatag": [],
                "payment_option_html": " ",
                "upon_request": "0",
                "available_for_purchase": "1",
                "all_categories": "0",
                "ProductImage": [],
                "Variant": [],
                "AdditionalInfos": []
            }
        }
}

Tabelas Auxiliares de Produtos

Tabela A - Disponibilidade do produto (campo available)

Tabela B - Produto promocional (campo promotion)

Tabela C - Produto com frete grátis (campo free_shipping)

Tabela D - Lançamento de produto (campo release)

Tabela E - Produto em destaque (campo hot)

Tabela F - Produto com variação (campo has_variation)

Tabela G - Produto em destaque (campo has_acceptance_terms)

Tabela H - Produto em destaque (campo has_buy_together)

Tabela I - Produto em destaque (campo virtual_product)

Consultar Dados do Produto#get

Requisição para a consulta de dados de um produto.

Método GET

https://{api_address}/products/:id?access_token={token}

Código de Exemplo:

curl --location -g --request GET '{{api_address}}/products/:id?access_token={{access_token}}'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{api_address}}/products/:id?access_token={{access_token}}');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("{{api_address}}/products/:id?access_token={{access_token}}");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("{{api_address}}/products/:id?access_token={{access_token}}")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

Parâmetros enviados

Retorno da API

Retorno de Invalid or expired token (401)

Obs: Chave inválida ou expirada, ocorre quando o access_token está expirado ou o seu valor está incorreto no parâmetro da url, pedimos que consuma à API abaixo para realizar a renovação ou geração da chave de acesso Clique aqui.

Retorno de Not Found e No records found (404)

Obs: O response code 404 é ocasionado quando há um erro de sintaxe na url da requisição ou quando não encontramos id passado por parâmetro na URL.

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

Retorno de Sucesso

{
    "Product": {
        "ean": "",
        "modified": "2019-01-21 09:22:21",
        "is_kit": "0",
        "slug": "produto-teste",
        "ncm": "90221991",
        "activation_date": "0000-00-00",
        "deactivation_date": "2018-07-10",
        "id": "8",
        "name": "Produto Teste",
        "title": "Titulo blablabla",
        "description": "",
        "description_small": "Descrição blablabla",
        "price": "30.00",
        "cost_price": "25.00",
        "dollar_cost_price": "0.00",
        "promotional_price": "10.00",
        "start_promotion": "2019-01-20",
        "end_promotion": "2019-02-01",
        "brand": "Dragon Shield",
        "brand_id": "4",
        "model": "MTESTEM",
        "weight": "2",
        "length": "1",
        "width": "10",
        "height": "15",
        "stock": "682",
        "category_id": "14",
        "category_name": "Playmat",
        "available": "1",
        "availability": "Disponível em 3 dia útil",
        "reference": "M01",
        "hot": "1",
        "release": "1",
        "additional_button": "0",
        "has_variation": "1",
        "has_acceptance_terms": "0",
        "has_buy_together": "1",
        "additional_message": "Informação Adicional 3",
        "warranty": "",
        "rating": "0",
        "count_rating": "0",
        "quantity_sold": "2",
        "ProductImage": [
            {
                "http": "http://images3.tcdn.com.br/img/img_prod/123/1_1_123.jpg",
                "https": "https://images.tcdn.com.br/img/img_prod/123/1_1_123.jpg",
                "thumbs": {
                    "30": {
                        "http": "http://images.tcdn.com.br/img/img_prod/123/30_1_1_123.jpg",
                        "https": "https://images2.tcdn.com.br/img/img_prod/123/30_1_1_123.jpg"
                    },
                    "90": {
                        "http": "http://images1.tcdn.com.br/img/img_prod/123/90_1_1_123.jpg",
                        "https": "https://images1.tcdn.com.br/img/img_prod/123/90_1_1_123.jpg"
                    },
                    "180": {
                        "http": "http://images3.tcdn.com.br/img/img_prod/123/180_1_1_123.jpg",
                        "https": "https://images4.tcdn.com.br/img/img_prod/123/180_1_1_123.jpg"
                    }
                }
            },
            {
                "http": "http://images1.tcdn.com.br/img/img_prod/123/1_2_123.jpg",
                "https": "https://images2.tcdn.com.br/img/img_prod/123/1_2_123.jpg",
                "thumbs": {
                    "30": {
                        "http": "http://images4.tcdn.com.br/img/img_prod/123/30_1_2_123.jpg",
                        "https": "https://images4.tcdn.com.br/img/img_prod/123/30_1_2_123.jpg"
                    },
                    "90": {
                        "http": "http://images4.tcdn.com.br/img/img_prod/123/90_1_2_123.jpg",
                        "https": "https://images1.tcdn.com.br/img/img_prod/123/90_1_2_123.jpg"
                    },
                    "180": {
                        "http": "http://images4.tcdn.com.br/img/img_prod/123/180_1_2_123.jpg",
                        "https": "https://images.tcdn.com.br/img/img_prod/123/180_1_2_123.jpg"
                    }
                }
            }
        ],
        "image": "1",
        "url": {
            "http": "http://{dominio_da_loja}/categoria/produto-de-teste",
            "https": "https://{dominio_da_loja}/categoria/produto-de-teste"
        },
        "created": "0000-00-00 00:00:00",
        "Properties": {
            "Teste Caracteristica": [
                "PP"
            ]
        },
        "payment_option": "R$ 9,70 à vista com desconto Boleto - Yapay",
        "payment_option_details": [
            {
                "display_name": "Boleto - Yapay",
                "type": "bank_billet",
                "plots": "1",
                "value": "9.70",
                "tax": "0.00"
            }
        ],
        "related_categories": [
            "2"
        ],
        "release_date": "",
        "shortcut": "produto-teste",
        "virtual_product": "",
        "minimum_stock": "0",
        "minimum_stock_alert": "0",
        "promotion_id": "4",
        "included_items": "Informação Adicional 2",
        "related_products": [
            "6",
            "8",
            "27",
            "29"
        ],
        "free_shipping": "1",
        "current_price": "10.00",
        "ipi": "0.110000",
        "acceptance_term_option": "2",
        "acceptance_term": "",
        "warranty_days": "0",
        "availability_days": "0",
        "cubic_weight": "32",
        "video": "",
        "metatag": [
            {
                "type": "description",
                "content": "Informação Adicional Teste"
            },
            {
                "type": "description",
                "content": ""
            },
            {
                "type": "keywords",
                "content": ""
            }
        ],
        "payment_option_html": " ",
        "percentage_discount": "-66.666667",
        "upon_request": "0",
        "available_for_purchase": "1",
        "all_categories": [
            "2",
            "8",
            "14"
        ],
        "Variant": [
            {
                "id": "204"
            }
        ],
        "AdditionalInfos": [
            {
                "id": "2",
                "info_id": "1",
                "type": "select",
                "display_as": "galery",
                "name": "Puxadores",
                "display_value": "1",
                "required": "1",
                "add_total": "1",
                "options": [
                    {
                        "id": "6",
                        "name": "ima",
                        "image": {
                            "http": "http://images.tcdn.com.br/img/img_prod/406562/imagem_6_2819240856c4c18e82e87.jpg",
                            "https": "https://images.tcdn.com.br/img/img_prod/406562/imagem_6_2819240856c4c18e82e87.jpg"
                        },
                        "value": "0.12"
                    }
                ],
                "active": "1",
                "deadline": "0"
            },
            {
                "id": "14",
                "info_id": "2",
                "type": "text",
                "name": "Data do Curso",
                "display_value": "1",
                "required": "1",
                "add_total": "0",
                "max_length": "0",
                "value": "0.00",
                "active": "1",
                "deadline": "0"
            }
        ]
    }
}

Tabelas Auxiliares de Produtos

Tabela A - Disponibilidade do produto (campo available)

Tabela B - Produto promocional (campo promotion)

Tabela C - Produto com frete grátis (campo free_shipping)

Tabela D - Lançamento de produto (campo release)

Tabela E - Produto em destaque (campo hot)

Tabela F - Produto com variação (campo has_variation)

Tabela G - Produto em destaque (campo has_acceptance_terms)

Tabela H - Produto em destaque (campo has_buy_together)

Tabela I - Produto em destaque (campo virtual_product)

Cadastrar Produto#post

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

Método POST

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

Código de Exemplo:

curl --location -g --request POST '{{api_address}}/products?access_token={{access_token}}' \
--data-raw '{
    "Product":  {
        "ean":"9999",
        "name":"Produto Teste API",
        "ncm":"99999999",
        "description":"Descrição do Produto de Teste da API",
        "description_small":"Produto de Teste da API",
        "price":0.01,
        "cost_price":0.01,
        "promotional_price":0.01,
        "start_promotion":"2019-03-01",
        "end_promotion":"2019-09-01",
        "ipi_value": 12,
        "brand":"marca",
        "model":"Modelo",
        "weight":1000,
        "length":10,
        "width":10,
        "height":10,
        "stock":100,
        "category_id":"2",
        "available":1,
        "availability":"Disponível em 3 dias",
        "availability_days":3,
        "reference":"111",
        "hot": "1",
        "release": "1",
        "additional_button": "0",
        "related_categories":[],
        "release_date":"",
        "metatag":[{"type":"keywords",
        "content":"Key1, Key2, Key3",
        "local":1}],
        "virtual_product":"0"
    }
}'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{api_address}}/products?access_token={{access_token}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/x-www-form-urlencoded'
));
$request->addPostParameter(array(
  '["Product"]["ean"]' => '98799979789879',
  '["Product"]["name"]' => 'Produto Teste API',
  '["Product"]["description"]' => 'Descrição do Produto de Teste da API',
  '["Product"]["description_small"]' => 'Produto de Teste da API',
  '["Product"]["price"]' => '10.01',
  '["Product"]["cost_price"]' => '10.01',
  '["Product"]["promotional_price"]' => '10.01',
  '["Product"]["start_promotion"]' => '2019-04-01',
  '["Product"]["end_promotion"]' => '2019-04-30',
  '["Product"]["brand"]' => 'Marca',
  '["Product"]["model"]' => 'Modelo',
  '["Product"]["weight"]' => '1000',
  '["Product"]["length"]' => '10',
  '["Product"]["width"]' => '10',
  '["Product"]["height"]' => '10',
  '["Product"]["stock"]' => '100',
  '["Product"]["category_id"]' => '2',
  '["Product"]["available"]' => '1',
  '["Product"]["availability"]' => 'Disponível em 3 dias',
  '["Product"]["availability_days"]' => '3',
  '["Product"]["reference"]' => '111',
  '["Product"]["hot"]' => '1',
  '["Product"]["release"]' => '1',
  '["Product"]["additional_button"]' => '0',
  '["Product"]["related_categories"]' => '[3,5,7]',
  '["Product"]["release_date"]' => '""',
  '["Product"]["shortcut"]' => '""',
  '["Product"]["virtual_product"]' => '0'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("{{api_address}}/products?access_token={{access_token}}");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/x-www-form-urlencoded");
request.AddParameter("[\"Product\"][\"ean\"]", "98799979789879");
request.AddParameter("[\"Product\"][\"name\"]", "Produto Teste API");
request.AddParameter("[\"Product\"][\"description\"]", "Descrição do Produto de Teste da API");
request.AddParameter("[\"Product\"][\"description_small\"]", "Produto de Teste da API");
request.AddParameter("[\"Product\"][\"price\"]", "10.01");
request.AddParameter("[\"Product\"][\"cost_price\"]", "10.01");
request.AddParameter("[\"Product\"][\"promotional_price\"]", "10.01");
request.AddParameter("[\"Product\"][\"start_promotion\"]", "2019-04-01");
request.AddParameter("[\"Product\"][\"end_promotion\"]", "2019-04-30");
request.AddParameter("[\"Product\"][\"brand\"]", "Marca");
request.AddParameter("[\"Product\"][\"model\"]", "Modelo");
request.AddParameter("[\"Product\"][\"weight\"]", "1000");
request.AddParameter("[\"Product\"][\"length\"]", "10");
request.AddParameter("[\"Product\"][\"width\"]", "10");
request.AddParameter("[\"Product\"][\"height\"]", "10");
request.AddParameter("[\"Product\"][\"stock\"]", "100");
request.AddParameter("[\"Product\"][\"category_id\"]", "2");
request.AddParameter("[\"Product\"][\"available\"]", "1");
request.AddParameter("[\"Product\"][\"availability\"]", "Disponível em 3 dias");
request.AddParameter("[\"Product\"][\"availability_days\"]", "3");
request.AddParameter("[\"Product\"][\"reference\"]", "111");
request.AddParameter("[\"Product\"][\"hot\"]", "1");
request.AddParameter("[\"Product\"][\"release\"]", "1");
request.AddParameter("[\"Product\"][\"additional_button\"]", "0");
request.AddParameter("[\"Product\"][\"related_categories\"]", "[3,5,7]");
request.AddParameter("[\"Product\"][\"release_date\"]", "\"\"");
request.AddParameter("[\"Product\"][\"shortcut\"]", "\"\"");
request.AddParameter("[\"Product\"][\"virtual_product\"]", "0");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
RequestBody body = RequestBody.create(mediaType, "[\"Product\"][\"ean\"]=98799979789879&[\"Product\"][\"name\"]=Produto Teste API&[\"Product\"][\"description\"]=Descrição do Produto de Teste da API&[\"Product\"][\"description_small\"]=Produto de Teste da API&[\"Product\"][\"price\"]=10.01&[\"Product\"][\"cost_price\"]=10.01&[\"Product\"][\"promotional_price\"]=10.01&[\"Product\"][\"start_promotion\"]=2019-04-01&[\"Product\"][\"end_promotion\"]=2019-04-30&[\"Product\"][\"brand\"]=Marca&[\"Product\"][\"model\"]=Modelo&[\"Product\"][\"weight\"]=1000&[\"Product\"][\"length\"]=10&[\"Product\"][\"width\"]=10&[\"Product\"][\"height\"]=10&[\"Product\"][\"stock\"]=100&[\"Product\"][\"category_id\"]=2&[\"Product\"][\"available\"]=1&[\"Product\"][\"availability\"]=Disponível em 3 dias&[\"Product\"][\"availability_days\"]=3&[\"Product\"][\"reference\"]=111&[\"Product\"][\"hot\"]=1&[\"Product\"][\"release\"]=1&[\"Product\"][\"additional_button\"]=0&[\"Product\"][\"related_categories\"]=[3,5,7]&[\"Product\"][\"release_date\"]=\"\"&[\"Product\"][\"shortcut\"]=\"\"&[\"Product\"][\"virtual_product\"]=0");
Request request = new Request.Builder()
  .url("{{api_address}}/products?access_token={{access_token}}")
  .method("POST", body)
  .addHeader("Content-Type", "application/x-www-form-urlencoded")
  .build();
Response response = client.newCall(request).execute();

Parâmetros enviados

Retorno da API

Retorno de Invalid or expired token (401)

Obs: Chave inválida ou expirada, ocorre quando o access_token está expirado ou o seu valor está incorreto no parâmetro da url, pedimos que consuma à API abaixo para realizar a renovação ou geração da chave de acesso. Clique aqui

Retorno de Bad Request (400)

Obs: O Retorno de Bad Request ocorre quando há algum valor diferente do tipo de atributo esperado ou quando há um erro na estrutura do JSON, para isso pedimos que seja feito uma análise comparativa entre o nosso modelo e o modelo elaborado na requisição.

Retorno de Not Found e No records found (404)

Obs: O response code 404 é ocasionado quando há um erro de sintaxe na url da requisição ou quando não encontramos id passado por parâmetro na URL.

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

Retorno com Sucesso:

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

Tabelas Auxiliares de Produtos

Tabela A - Disponibilidade do produto (campo available)

Tabela B - Produto em destaque (campo virtual_product)

Especificações para o envio das imagens na API

obs: Para realizar o envio de imagem pedimos que siga conforme o link a baixo, pois a partir 02 de Julho de 2023 iremos descontinuar o envio de imagem pelo "{ "Product": { picture_source_x;}} e passaremos a realizar o envio de imagem conforme o link a baixo:
Clique aqui

Atualizar Dados do Produto#put

Requisição para alterar os dados de um produto. Deverá enviar o JSON com os dados do produto para a alteração.

Método PUT

https://{api_address}/products/:id?access_token={token}

Parâmetros enviados

Exemplo de Atualização de vários dados:

{
    "Product": {
        "price": 100.00,
        "stock": 100
    }
}

Exemplo de Atualização apenas do estoque:

{
    "Product": {
        "stock": 100
    }
}

obs: Para realizar o envio de imagem pedimos que siga conforme o link a baixo, pois a partir 02 de Julho de 2023 iremos descontinuar o envio de imagem pelo "{ "Product": { picture_source_x;}} e passaremos a realizar o envio de imagem conforme o link a baixo:
Clique aqui

Retorno da API

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

Retorno com Sucesso:

{
  "message":"Saved",
  "id":"123",
  "code":200
}

Retorno de Invalid or expired token (401)

Obs: Chave inválida ou expirada, ocorre quando o access_token está expirado ou o seu valor está incorreto no parâmetro da url, pedimos que consuma à API abaixo para realizar a renovação ou geração da chave de acesso. Clique aqui

Retorno de Bad Request (400)

Obs: O Retorno de Bad Request ocorre quando há algum valor diferente do tipo de atributo esperado ou quando há um erro na estrutura do JSON, para isso pedimos que seja feito uma análise comparativa entre o nosso modelo e o modelo elaborado na requisição.

Retorno de Not Found e No records found (404)

Obs: O response code 404 é ocasionado quando há um erro de sintaxe na url da requisição ou quando não encontramos id passado por parâmetro na URL.

Tabelas Auxiliares de Produtos

Tabela A - Disponibilidade do produto (campo available)

Exclusão de Produtos#delete

Requisição para excluir um Produto ou um Kit

Código de Exemplo:

curl --location -g --request DELETE 'https://{api_address}/products/:id/?access_token={token}'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{api_address}/products/:id/?access_token={token}');
$request->setMethod(HTTP_Request2::METHOD_DELETE);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://{api_address}/products/:id/?access_token={token}");
client.Timeout = -1;
var request = new RestRequest(Method.DELETE);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://{api_address}/products/:id/?access_token={token}")
  .method("DELETE", body)
  .build();
Response response = client.newCall(request).execute();

Método DELETE

https://{api_address}/products/:id/?access_token={token}

Parâmetros enviados

Retorno da API

Retorno de Invalid or expired token (401)

Obs: Chave inválida ou expirada, ocorre quando o access_token está expirado ou o seu valor está incorreto no parâmetro da url, pedimos que consuma à API abaixo para realizar a renovação ou geração da chave de acesso. Clique aqui

Retorno de Not Found e No records found (404)

Obs: O response code 404 é ocasionado quando há um erro de sintaxe na url da requisição ou quando não encontramos id passado por parâmetro na URL.

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

Retorno com Sucesso:

{
  "message":"Deleted",
  "id":"123",
  "code":200
}

Exclusão de Kit#delete

Método DELETE

https://{api_address}/products/product_parent_id?access_token={token}

Parâmetros enviados

Retorno da API

Retorno de Invalid or expired token (401)

Obs: Chave inválida ou expirada, ocorre quando o access_token está expirado ou o seu valor está incorreto no parâmetro da url, pedimos que consuma à API abaixo para realizar a renovação ou geração da chave de acesso. Clique aqui

Retorno de Not Found e No records found (404)

Obs: O response code 404 é ocasionado quando há um erro de sintaxe na url da requisição ou quando não encontramos id passado por parâmetro na URL.

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

Retorno com Sucesso:

{
  "message":"Deleted",
  "id":"123",
  "code":200
}

APIs de imagens de produtos e variações

Cadastro e Atualização de Imagem de Produto#post

Requisição para cadastrar ou atualizar imagens do produto.

https://{{api_address}}/products/{id_do_produto}/images?access_token={{access_token}

Observação:

Assim que realizado o envio, as imagens serão processadas em fila, podendo levar alguns minutos para serem exibidas no cadastro do produto.

Regras de envio

• Quantidade de imagens: Até 15 imagens;
• Formatos: JPG, JPEG e PNG;
• Dimensão: Limite máximo de 2000 x 2000 pixels;
• Tamanho: Até 350 Kb;
• URL: Deverá ser de acesso público, não conter espaços, acentuação ou caracteres especiais;
• Não enviar a imagem com o nome já enviado anteriormente;
• A imagem não poderá possuir uma extensão renomeada;

Exemplo de código:

 {
    "Images":  {
        "picture_source_1":"http://bancodeimagens/imagem1.jpg",
        "picture_source_2":"http://bancodeimagens/imagem2.jpg",
        "picture_source_3":"http://bancodeimagens/imagem3.jpg",
        "picture_source_4":"http://bancodeimagens/imagem4.jpg",
        "picture_source_5":"http://bancodeimagens/imagem5.jpg",
        "picture_source_6":"http://bancodeimagens/imagem6.jpg",
        "picture_source_7":"http://bancodeimagens/imagem7.jpg",
        "picture_source_8":"http://bancodeimagens/imagem8.jpg",
        "picture_source_9":"http://bancodeimagens/imagem9.jpg",
        "picture_source_10":"http://bancodeimagens/imagem10.jpg",
        "picture_source_11":"http://bancodeimagens/imagem11.jpg",
        "picture_source_12":"http://bancodeimagens/imagem12.jpg",
        "picture_source_13":"http://bancodeimagens/imagem13.jpg",
        "picture_source_14":"http://bancodeimagens/imagem14.jpg",
        "picture_source_15":"http://bancodeimagens/imagem15.jpg"
    }
}

Resposta:

{
    "message": "Uploaded images",
    "code": 200
}

OBS: Para atualização de imagem, enviar APENAS os campos o qual será atualizado, ou seja, caso queira atualizar apenas a 3 imagem deve enviar apenas o campo picture_source_3.

Cadastro e Atualização de Imagem da Variação#post

Requisição para cadastrar ou atualizar imagens da variação.

https://{{api_address}}/variants/{id_da_variacao}/images?access_token={{access_token}}

Observação:

Assim que realizado o envio, as imagens serão processadas em fila, podendo levar alguns minutos para serem exibidas no cadastro do produto.

Regras de envio

• Quantidade de imagens: Até 15 imagens;
• Formatos: JPG, JPEG e PNG;
• Dimensão: Limite máximo de 2000 x 2000 pixels;
• Tamanho: Até 350 Kb;
• URL: Deverá ser de acesso público, não conter espaços, acentuação ou caracteres especiais;
• Não enviar a imagem com o nome já enviado anteriormente;
• A imagem não poderá possuir uma extensão renomeada;

Exemplo de código:

 '{
    "Images":  {
        "picture_source_1":"http://bancodeimagens/imagem1.jpg",
        "picture_source_2":"http://bancodeimagens/imagem2.jpg",
        "picture_source_3":"http://bancodeimagens/imagem3.jpg",
        "picture_source_4":"http://bancodeimagens/imagem4.jpg",
        "picture_source_5":"http://bancodeimagens/imagem5.jpg",
        "picture_source_6":"http://bancodeimagens/imagem6.jpg",
        "picture_source_7":"http://bancodeimagens/imagem7.jpg",
        "picture_source_8":"http://bancodeimagens/imagem8.jpg",
        "picture_source_9":"http://bancodeimagens/imagem9.jpg",
        "picture_source_10":"http://bancodeimagens/imagem10.jpg",
        "picture_source_11":"http://bancodeimagens/imagem11.jpg",
        "picture_source_12":"http://bancodeimagens/imagem12.jpg",
        "picture_source_13":"http://bancodeimagens/imagem13.jpg",
        "picture_source_14":"http://bancodeimagens/imagem14.jpg",
        "picture_source_15":"http://bancodeimagens/imagem15.jpg"
    }
}'

Resposta:

{
    "message": "Uploaded images",
    "code": 200
}

OBS: Para atualização de imagem, enviar APENAS os campos o qual será atualizado, ou seja, caso queira atualizar apenas a 3 imagem deve enviar apenas o campo picture_source_3.

Remoção de imagens#post

A remoção da imagem no cadastro do produto será realizada ao recebermos na requisição um espaço em branco entre aspas no lugar da URL, referente a posição da imagem que se pretende remover.

Exemplo: Remover imagem da posição 3 do produto id 1234

https://{{api_address}}/products/1234/images?access_token={{access_token}}

Observação:

Assim que realizado o envio, as imagens serão processadas em fila, podendo levar alguns minutos para serem exibidas no cadastro do produto.

Exemplo de código:

{
   "Images":  {
        "picture_source_3":" ",
    }
}

APIs de Produtos Vendidos

Listagem de Produtos Vendidos#get

Requisição para consultar os dados dos produtos vendidos.

Método GET

https://{api_address}/products_solds/:id

Código de Exemplo:

curl --location -g --request GET 'https://{api_address}/products_solds/'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{api_address}/products_solds/');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://{api_address}/products_solds/");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://{api_address}/products_solds/")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

Parâmetros enviados

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

Retorno de Sucesso

{
    "paging": {
        "total": 1,
        "page": 1,
        "offset": 0,
        "limit": 30,
        "maxLimit": 50
    },
    "sort": [
        {
            "id": "asc"
        }
    ],
    "availableFilters": [
        "id",
        "product_id"
    ],
    "appliedFilters": [],
    "ProductsSolds": [
        {
            "ProductsSold": {
                "id": "123",
                "product_id": "456",
                "order_id": "789",
                "name": "Produto de Teste",
                "price": "51.80",
                "original_price": "50.00",
                "quantity": "1",
                "model": "Modelo de Teste",
                "reference": "REF0001",
                "variant_id": "0",
                "additional_information": ""
            }
        }
    ]
}

APIs de Pedidos

Listagem de Pedidos#get

Requisição para consultar os dados das categorias de forma estruturada.

Código de Exemplo:

curl --location -g --request GET 'https://{api_address}/orders'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{api_address}/orders');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://{api_address}/orders");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://{api_address}/orders")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

Método GET

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

Parâmetros enviados

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

Retorno de Sucesso:

{
  {
    "paging": {
        "total": 7,
        "page": 1,
        "offset": 0,
        "limit": 30,
        "maxLimit": 50
    },
    "sort": [
        {
          "id": "asc"
        }
    ],
    "availableFilters": [
        "id",
        "status",
        "partner_id",
        "session_id",
        "sending_code",
        "customer_id",
        "shipment",
        "point_sale",
        "payment_form",
        "access_code",
        "external_code",
        "has_payment",
        "has_invoice",
        "has_shipment",
        "with_statuses",
        "printed",
        "payment_method_id",
        "store_note",
        "discount_coupon",
        "modified",
        "date",
        "shipment_date",
        "payment_date"
    ],
    "appliedFilters": [],
    "Orders": [
      {
        "Order": {
            "status": "A ENVIAR",
            "id": "5",
            "date": "2020-12-07",
            "customer_id": "5",
            "partial_total": "35999.00",
            "taxes": "0.00",
            "discount": "0.00",
            "point_sale": "LOJA VIRTUAL",
            "shipment": "Correios Expresso",
            "shipment_value": "28.35",
            "shipment_date": "",
            "store_note": "07/12/2020 11:55:22 Pedido em 1 vez de R$ 27,027.60 através do Boleto - Yapay - Boleto",
            "discount_coupon": "natal25/8999.75",
            "payment_method_rate": "0.00",
            "value_1": "0.00",
            "payment_form": "Boleto - Yapay",
            "sending_code": "",
            "session_id": "rdlq7ogripa61r33p75bei8cj2",
            "total": "27027.60",
            "payment_date": "0000-00-00",
            "access_code": "DB91EEA5D671CA2",
            "progressive_discount": "0.00",
            "shipping_progressive_discount": "0.00",
            "shipment_integrator": "Frete Fácil",
            "modified": "2020-12-21 11:21:52",
            "printed": "",
            "interest": "0.00",
            "id_quotation": "3220",
            "estimated_delivery_date": "2020-12-22",
            "external_code": "",
            "has_payment": "0",
            "has_shipment": "0",
            "has_invoice": "1",
            "total_comission_user": "0.00",
            "total_comission": "0.00",
            "coupon": {
                "code": "natal25",
                "discount": "8999.75"
            },
            "is_traceable": "",
            "OrderStatus": {
                "id": "1",
                "default": "1",
                "type": "open",
                "show_backoffice": "1",
                "allow_edit_order": "0",
                "description": "",
                "status": "A ENVIAR",
                "show_status_central": "",
                "background": "#CAFAD1"
            },
            "PickupLocation": [],
            "ProductsSold": [
                {
                    "id": "5"
                }
            ],
            "Payment": [],
            "OrderInvoice": [
                {
                    "id": "7",
                    "link": ""
                }
            ],
            "MlOrder": [],
            "OrderTransactions": [],
            "MarketplaceOrder": [],
            "Extensions": []
        }
    }
}

OBS: As Tabelas auxiliares estão logo a baixo do DELETE

Dados do Pedido#get

Exemplos com availableFilters

Filtrar pedido por data específica
'https://{api_address}/orders?access_token={{access_token}}&date=2021-07-13,2021-07-13 23:59:59'

Requisição para consultar os dados das categorias de forma estruturada.

Método GET

https://{api_address}/orders/:id?access_token={{token}}

Parâmetros enviados:

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

Retorno de Sucesso:

{
  "Order": {
      "status": "FINALIZADO",
      "id": "15",
      "date": "2021-02-10",
      "hour": "11:28:21",
      "customer_id": "1",
      "partial_total": "59900.00",
      "taxes": "0.00",
      "discount": "0.00",
      "point_sale": "LOJA VIRTUAL",
      "shipment": "Correios Expresso",
      "shipment_value": "38.91",
      "shipment_date": "",
      "delivered": "",
      "shipping_cancelled": "",
      "store_note": "10/02/2021 11:28:28 Pedido em 1 vez de R$ 62,935.86 através do Boleto - Yapay - Boleto Link da transação: https://intermediador.yapay.com.br/orders/billet/17471d7cd90f7d3jk54643e1da0f15",
      "customer_note": "",
      "partner_id": "0",
      "discount_coupon": "",
      "payment_method_rate": "2996.95",
      "installment": "1",
      "value_1": "0.00",
      "sending_code": "",
      "sending_date": "0000-00-00",
      "billing_address": "0",
      "delivery_time": "3",
      "payment_method_id": "80",
      "payment_method": "Boleto - Yapay",
      "session_id": "k8ku3icuvb5uge2qj7u8gbtli6",
      "total": "62935.86",
      "payment_date": "2021-02-10",
      "access_code": "38D071AEFEF4960",
      "shipment_integrator": "Frete Fácil",
      "modified": "2021-05-06 10:38:45",
      "printed": "",
      "interest": "0.00",
      "id_quotation": "3220",
      "estimated_delivery_date": "2021-02-15",
      "is_traceable": "",
      "external_code": "",
      "tracking_url": "",
      "has_payment": "0",
      "has_shipment": "0",
      "has_invoice": "0",
      "total_comission_user": "0.00",
      "total_comission": "0.00",
      "OrderStatus": {
          "id": "69",
          "default": "1",
          "type": "closed",
          "show_backoffice": "1",
          "allow_edit_order": "0",
          "description": "",
          "status": "FINALIZADO",
          "show_status_central": "",
          "background": "#85CC8D"
      },
      "PickupLocation": [],
      "ProductsSold": [
          {
              "id": "17"
          }
      ],
      "Payment": [],
      "OrderInvoice": [],
      "MlOrder": [],
      "OrderTransactions": [
            {
                "url_payment": "https://intermediador.yapay.com.br/orders/billet/8eb117cdada159753468efe9cd45157c7"
            }
        ],
        "MarketplaceOrder": [],
        "Extensions": [],
        "CustomerAddress": {
            "id": "15"
        },
        "ShippingLabel": {
            "application": "Nome do Aplictivo",
            "url": "https://trayparceiros.commercesuite.com.br?store_id=391250&id=25"
        },
        "payments_notification": {
            "notification": "https://trayparceiros.commercesuite.com.br/loja/retorno_pagamento.php?loja=391250&gateway=5&codigoAcesso=F32QFG02A185CFF¬ification=true"
        },
        "partner_name": ""
    }
}

OBS: As Tabelas auxiliares estão logo a baixo do DELETE

Dados Completo do Pedido#get

Código de Exemplo:

curl --location -g --request GET 'https://{api_address}/orders/:id/complete'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{api_address}/orders/:id/complete');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://{api_address}/orders/:id/complete");
client.Timeout = -1;
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://{api_address}/orders/:id/complete")
  .method("GET", null)
  .build();
Response response = client.newCall(request).execute();

Requisição para consultar os dados das categorias de forma estruturada.

Método GET

https://{api_address}/orders/:id/complete?access_token={{token}}

Parâmetros enviados:

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

Retorno de Sucesso:

{
  "Order": {
      "status": "FINALIZADO",
      "id": "15",
      "date": "2021-02-10",
      "hour": "11:28:21",
      "customer_id": "1",
      "partial_total": "59900.00",
      "taxes": "0.00",
      "discount": "0.00",
      "point_sale": "LOJA VIRTUAL",
      "shipment": "Correios Expresso",
      "shipment_value": "38.91",
      "shipment_date": "",
      "delivered": "",
      "shipping_cancelled": "",
      "store_note": "10/02/2021 11:28:28 Pedido em 1 vez de R$ 62,935.86 através do Boleto - Yapay - Boleto Link da transação: https://intermediador.yapay.com.br/orders/billet/17471d7cd90fd3ee4643e1da0f15",
      "customer_note": "",
      "partner_id": "0",
      "discount_coupon": "",
      "payment_method_rate": "2996.95",
      "installment": "1",
      "value_1": "0.00",
      "sending_code": "",
      "sending_date": "0000-00-00",
      "billing_address": "0",
      "delivery_time": "3",
      "payment_method_id": "80",
      "payment_method": "Boleto - Yapay",
      "session_id": "k8ku3icuvb5uge2qj7u8gbtli6",
      "total": "62935.86",
      "payment_date": "2021-02-10",
      "access_code": "38D071AEFEF4960",
      "shipment_integrator": "Frete Fácil",
      "modified": "2021-05-06 10:38:45",
      "printed": "",
      "interest": "0.00",
      "id_quotation": "3220",
      "estimated_delivery_date": "2021-02-15",
      "is_traceable": "",
      "external_code": "",
      "tracking_url": "",
      "has_payment": "0",
      "has_shipment": "0",
      "has_invoice": "0",
      "total_comission_user": "0.00",
      "total_comission": "0.00",
      "OrderStatus": {
          "id": "69",
          "default": "1",
          "type": "closed",
          "show_backoffice": "1",
          "allow_edit_order": "0",
          "description": "",
          "status": "FINALIZADO",
          "show_status_central": "",
          "background": "#85CC8D"
      },
      "PickupLocation": [],
      "cost": "0",
      "urls": {
          "payment": "https://trayparceiros.commercesuite.com.br/loja/pagamento.php?loja=391250&pedido=38D071AEFEF4960"
      },
      "payment_method_type": "bank_billet",
      "Customer": {
          "cnpj": "",
          "newsletter": "0",
          "created": "0000-00-00 00:00:00",
          "terms": "0000-00-00 00:00:00",
          "id": "1",
          "name": "Nome Cliente",
          "registration_date": "2008-10-14",
          "rg": "",
          "cpf": "12442673177",
          "phone": "1434546185",
          "cellphone": "",
          "birth_date": "0000-00-00",
          "gender": "0",
          "email": "email@tray.com.br",
          "nickname": "",
          "token": "0BBB15A404B6BA1",
          "total_orders": "0",
          "observation": "Teste 2",
          "type": "0",
          "company_name": "",
          "state_inscription": "",
          "reseller": "0",
          "discount": "0.000",
          "blocked": "",
          "credit_limit": "0.00",
          "indicator_id": "0",
          "profile_customer_id": "1",
          "last_sending_newsletter": "0000-00-00",
          "last_purchase": "2021-02-23",
          "last_visit": "2021-02-25",
          "last_modification": "0000-00-00 00:00:00",
          "address": "Rua Teste",
          "zip_code": "17500-000",
          "number": "55",
          "complement": "Casa 26",
          "neighborhood": "Centro",
          "city": "Marília",
          "state": "SP",
          "country": "Brasil",
          "modified": "2021-04-05 09:33:59",
          "Extensions": {
              "Profile": {
                  "id": "1",
                  "name": "Padrao"
              },
              "Profiles": [
                  {
                      "id": "1",
                      "price_list_id": "0",
                      "name": "Padrao",
                      "approves_registration": "0",
                      "show_price": "",
                      "theme_id": "0",
                      "selected": "1"
                  }
              ]
          },
          "CustomerAddresses": [
              {
                  "CustomerAddress": {
                      "id": "7",
                      "customer_id": "1",
                      "address": "Rua Teste",
                      "number": "55",
                      "complement": "Casa 26",
                      "neighborhood": "Centro",
                      "city": "Marília",
                      "state": "SP",
                      "zip_code": "17500-000",
                      "country": "Brasil",
                      "type": "1",
                      "active": "1",
                      "description": "Residencial",
                      "recipient": "",
                      "type_delivery": "1",
                      "not_list": "0"
                  }
              }
          ]
      },
      "ProductsSold": [
          {
              "ProductsSold": {
                  "product_kit_id": "0",
                  "product_kit_id_kit": "0",
                  "id_campaign": "0",
                  "product_id": "13",
                  "quantity": "1",
                  "id": "17",
                  "order_id": "15",
                  "name": "Notebook Alienware Gamer,
                  "original_name": "Notebook Alienware Gamer",
                  "virtual_product": "0",
                  "ean": "",
                  "Sku": [
                      {
                        "type": "Voltagem",
                        "value": "110v"
                      }
                  ],
                  "price": "59900.00",
                  "cost_price": "0.00",
                  "original_price": "59900.00",
                  "weight": "3000",
                  "weight_cubic": "15000",
                  "brand": "Dell Alienware",
                  "model": "area51m",
                  "reference": "",
                  "length": "40",
                  "width": "45",
                  "height": "40",
                  "variant_id": "25",
                  "additional_information": "",
                  "text_variant": "",
                  "warranty": "",
                  "bought_together_id": "0",
                  "ncm": "",
                  "included_items": "",
                  "release_date": "",
                  "commissioner_value": "0.00",
                  "comissao": "0.00",
                  "ProductSoldImage": [
                      {
                        "http": "http://images.tcdn.com.br/img/img_prod/391250/notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png",
                        "https": "https://images.tcdn.com.br/img/img_prod/391250/notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png",
                        "thumbs": {
                            "30": {
                                "http": "http://images.tcdn.com.br/img/img_prod/391250/30_notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png",
                                "https": "https://images.tcdn.com.br/img/img_prod/391250/30_notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png"
                            },
                            "90": {
                                "http": "http://images.tcdn.com.br/img/img_prod/391250/90_notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png",
                                "https": "https://images.tcdn.com.br/img/img_prod/391250/90_notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png"
                            },
                            "180": {
                                "http": "http://images.tcdn.com.br/img/img_prod/391250/180_notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png",
                                "https": "https://images.tcdn.com.br/img/img_prod/391250/180_notebook_alienware_gamer_13_1_8396502fb367dd214dd15f06782390c3.png"
                            }
                          }
                      }
                  ],
                  "Category": [
                      {
                        "id": "5",
                        "name": "Notebooks",
                        "main_category": "0"
                      },
                      {
                        "id": "15",
                        "name": "Gamer",
                        "main_category": "1"
                      }
                  ],
                  "is_giveaway": "",
                  "BoughtTogether": [],
                  "url": {
                    "http": "http://trayparceiros.commercesuite.com.br/notebooks/gamer/notebook-alienware-gamer",
                    "https": "https://trayparceiros.commercesuite.com.br/notebooks/gamer/notebook-alienware-gamer"
                  },
                  "Discount": [],
                  "Stock": {
                    "id": "1",
                    "name": "Loja"
                  }
              }
          }
      ],
      "OrderInvoice": [],
      "Payment": [],
      "MlOrder": [],
      "MarketplaceOrder": [
            {
                "MarketplaceOrder": {
                    "order_id": "123456",
                    "marketplace_name": "Dafiti",
                    "marketplace_seller_name": "Loja",
                    "marketplace_seller_id": "",
                    "marketplace_document": "1154987592",
                    "payment_responsible_document": "11200456549",
                    "marketplace_order_id": "987654",
                    "marketplace_shipping_id": "",
                    "marketplace_shipping_type": "",
                    "marketplace_internal_status": "",
                    "created": "2021-06-11 10:00:51",
                    "updated": "2021-06-11 10:00:51"
                }
            }
        ],
      "OrderTransactions": [
            {
                "url_payment": "https://intermediador.yapay.com.br/orders/billet/8eb117cdada15975368efe9cd45157c7",
                "bank_slip": ""
            }
        ],
        "OrderInvoiceAmount": [],
        "ExtraTabs": [],
        "ShippingLabel": {
            "application": "Nome do Aplicativo",
            "url": "https://trayparceiros.commercesuite.com.br?store_id=391250&id=25"
        },
        "PaymentMethodMessage": {
            "text": "",
            "text_pag": "",
            "text_confirm": "",
            "confirmation": "0"
        },
        "payments_notification": {
            "notification": "https://trayparceiros.commercesuite.com.br/loja/retorno_pagamento.php?loja=391250&gateway=5&codigoAcesso=F32GTQ92A185CFF¬ification=true"
        },
        "partner_name": ""
    },
    "Extensions": [],
    "User": [],
    "Confirmation": []
}

OBS: As Tabelas auxiliares estão logo a baixo do DELETE

Cadastrar Pedido#post

Requisição para consultar os dados das categorias de forma estruturada.

Código de Exemplo:

curl --location -g --request POST 'https://{api_address}/orders?access_token={{access_token}}' \
--data-urlencode '["Order"]["point_sale"]=PARTICULAR' \
--data-urlencode '["Order"]["session_id"]=0BBB15A404B6BA1' \
--data-urlencode '["Order"]["shipment"] =Sedex' \
--data-urlencode '["Order"]["shipment_value"]=10.44' \
--data-urlencode '["Order"]["payment_form"]=Boleto - TrayCheckout' \
--data-urlencode '["Order"]["Customer"]["type"]=0' \
--data-urlencode '["Order"]["Customer"]["name"]=Nome do Cliente' \
--data-urlencode '["Order"]["Customer"]["cpf"]=00000000000' \
--data-urlencode '["Order"]["Customer"]["email"]=email@docliente.com' \
--data-urlencode '["Order"]["Customer"]["rg"]=00.000.000-X' \
--data-urlencode '["Order"]["Customer"]["gender"]=M' \
--data-urlencode '["Order"]["Customer"]["phone"]=1133330001' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["address"]=Endereço do Cliente' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["zip_code"]=04001001' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["number"]=123' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["complement"]=Sala 123' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["neighborhood"] =Bairro do Cliente' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["city"]=Cidade do Cliente' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["state"]=SP' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["country"]=BRASIL' \
--data-urlencode '["Order"]["Customer"]["CustomerAddress"][0]["type"]=1' \
--data-urlencode '["Order"]["Customer"]["ProductsSold"][0]["product_id"]=1' \
--data-urlencode '["Order"]["Customer"]["ProductsSold"][0]["variant_id"]=12' \
--data-urlencode '["Order"]["Customer"]["ProductsSold"][0]["price"]=42.90' \
--data-urlencode '["Order"]["Customer"]["ProductsSold"][0]["original_price"]=42.90' \
--data-urlencode '["Order"]["Customer"]["ProductsSold"][0]["quantity"]=1' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_name"]=Mercado Livre' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_seller_name"]=1234567890' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_seller_id"]=273480425' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_document"]=0000000000000' \
--data-urlencode '["Order"]["MarketplaceOrder""]["payment_responsible_document"]=0000000000000' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_order_id"]=4429804558' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_shipping_id"]=40457395268' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_shipping_type"]=me2' \
--data-urlencode '["Order"]["MarketplaceOrder""]["marketplace_internal_status"]=shipping'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{api_address}/orders?access_token={{access_token}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->addPostParameter(array(
  '["Order"]["point_sale"]' => 'PARTICULAR',
  '["Order"]["session_id"] ' => '0BBB15A404B6BA1',
  '["Order"]["shipment"] ' => 'Sedex',
  '["Order"]["shipment_value"]' => '10.44',
  '["Order"]["payment_form"]' => 'Boleto - TrayCheckout',
  '["Order"]["Customer"]["type"]' => '0',
  '["Order"]["Customer"]["name"]' => 'Nome do Cliente',
  '["Order"]["Customer"]["cpf"]' => '00000000000',
  '["Order"]["Customer"]["email"]' => 'email@docliente.com',
  '["Order"]["Customer"]["rg"]' => '00.000.000-X',
  '["Order"]["Customer"]["gender"]' => 'M',
  '["Order"]["Customer"]["phone"]' => '1133330001',
  '["Order"]["Customer"]["CustomerAddress"][0]["address"]' => 'Endereço do Cliente',
  '["Order"]["Customer"]["CustomerAddress"][0]["zip_code"]' => '04001001',
  '["Order"]["Customer"]["CustomerAddress"][0]["number"]' => '123',
  '["Order"]["Customer"]["CustomerAddress"][0]["complement"]' => 'Sala 123',
  '["Order"]["Customer"]["CustomerAddress"][0]["neighborhood"] ' => 'Bairro do Cliente',
  '["Order"]["Customer"]["CustomerAddress"][0]["city"]' => 'Cidade do Cliente',
  '["Order"]["Customer"]["CustomerAddress"][0]["state"]' => 'SP',
  '["Order"]["Customer"]["CustomerAddress"][0]["country"]' => 'BRASIL',
  '["Order"]["Customer"]["CustomerAddress"][0]["type"]' => '1',
  '["Order"]["Customer"]["ProductsSold"][0]["product_id"]' => '1',
  '["Order"]["Customer"]["ProductsSold"][0]["variant_id"]' => '12',
  '["Order"]["Customer"]["ProductsSold"][0]["price"]' => '42.90',
  '["Order"]["Customer"]["ProductsSold"][0]["original_price"]' => '42.90',
  '["Order"]["Customer"]["ProductsSold"][0]["quantity"]' => '1',
  '["Order"]["MarketplaceOrder""]["marketplace_name"]' => 'Mercado Livre',
  '["Order"]["MarketplaceOrder""]["marketplace_seller_name"]' => '1234567890',
  '["Order"]["MarketplaceOrder""]["marketplace_seller_id"]' => '273480425',
  '["Order"]["MarketplaceOrder""]["marketplace_document"]' => '0000000000000',
  '["Order"]["MarketplaceOrder""]["payment_responsible_document"]' => '0000000000000',
  '["Order"]["MarketplaceOrder""]["marketplace_order_id"]' => '4429804558',
  '["Order"]["MarketplaceOrder""]["marketplace_shipping_id"]' => '40457395268',
  '["Order"]["MarketplaceOrder""]["marketplace_shipping_type"]' => 'me2',
  '["Order"]["MarketplaceOrder""]["marketplace_internal_status"]' => 'shipping'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://{api_address}/orders?access_token={{access_token}}");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddParameter("[\"Order\"][\"point_sale\"]", "PARTICULAR");
request.AddParameter("[\"Order\"][\"session_id\"]", "0BBB15A404B6BA1");
request.AddParameter("[\"Order\"][\"shipment\"] ", "Sedex");
request.AddParameter("[\"Order\"][\"shipment_value\"]", "10.44");
request.AddParameter("[\"Order\"][\"payment_form\"]", "Boleto - TrayCheckout");
request.AddParameter("[\"Order\"][\"Customer\"][\"type\"]", "0");
request.AddParameter("[\"Order\"][\"Customer\"][\"name\"]", "Nome do Cliente");
request.AddParameter("[\"Order\"][\"Customer\"][\"cpf\"]", "00000000000");
request.AddParameter("[\"Order\"][\"Customer\"][\"email\"]", "email@docliente.com");
request.AddParameter("[\"Order\"][\"Customer\"][\"rg\"]", "00.000.000-X");
request.AddParameter("[\"Order\"][\"Customer\"][\"gender\"]", "M");
request.AddParameter("[\"Order\"][\"Customer\"][\"phone\"]", "1133330001");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"address\"]", "Endereço do Cliente");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"zip_code\"]", "04001001");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"number\"]", "123");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"complement\"]", "Sala 123");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"neighborhood\"] ", "Bairro do Cliente");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"city\"]", "Cidade do Cliente");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"state\"]", "SP");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"country\"]", "BRASIL");
request.AddParameter("[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"type\"]", "1");
request.AddParameter("[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"product_id\"]", "1");
request.AddParameter("[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"variant_id\"]", "12");
request.AddParameter("[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"price\"]", "42.90");
request.AddParameter("[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"original_price\"]", "42.90");
request.AddParameter("[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"quantity\"]", "1");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_name\"]", "Mercado Livre");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_seller_name\"]", "1234567890");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_seller_id\"]", "273480425");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_document\"]", "0000000000000");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"payment_responsible_document\"]", "0000000000000");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_order_id\"]", "4429804558");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_shipping_id\"]", "40457395268");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_shipping_type\"]", "me2");
request.AddParameter("[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_internal_status\"]", "shipping");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "[\"Order\"][\"point_sale\"]=PARTICULAR&[\"Order\"][\"session_id\"]=0BBB15A404B6BA1&[\"Order\"][\"shipment\"] =Sedex&[\"Order\"][\"shipment_value\"]=10.44&[\"Order\"][\"payment_form\"]=Boleto - TrayCheckout&[\"Order\"][\"Customer\"][\"type\"]=0&[\"Order\"][\"Customer\"][\"name\"]=Nome do Cliente&[\"Order\"][\"Customer\"][\"cpf\"]=00000000000&[\"Order\"][\"Customer\"][\"email\"]=email@docliente.com&[\"Order\"][\"Customer\"][\"rg\"]=00.000.000-X&[\"Order\"][\"Customer\"][\"gender\"]=M&[\"Order\"][\"Customer\"][\"phone\"]=1133330001&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"address\"]=Endereço do Cliente&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"zip_code\"]=04001001&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"number\"]=123&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"complement\"]=Sala 123&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"neighborhood\"] =Bairro do Cliente&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"city\"]=Cidade do Cliente&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"state\"]=SP&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"country\"]=BRASIL&[\"Order\"][\"Customer\"][\"CustomerAddress\"][0][\"type\"]=1&[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"product_id\"]=1&[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"variant_id\"]=12&[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"price\"]=42.90&[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"original_price\"]=42.90&[\"Order\"][\"Customer\"][\"ProductsSold\"][0][\"quantity\"]=1&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_name\"]=Mercado Livre&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_seller_name\"]=1234567890&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_seller_id\"]=273480425&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_document\"]=0000000000000&[\"Order\"][\"MarketplaceOrder\"\"][\"payment_responsible_document\"]=0000000000000&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_order_id\"]=4429804558&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_shipping_id\"]=40457395268&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_shipping_type\"]=me2&[\"Order\"][\"MarketplaceOrder\"\"][\"marketplace_internal_status\"]=shipping");
Request request = new Request.Builder()
  .url("https://{api_address}/orders?access_token={{access_token}}")
  .method("POST", body)
  .build();
Response response = client.newCall(request).execute();

Método POST

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

Parâmetros enviados:

Estrutura do Json:

{
    "Order":{
      "point_sale":"PARTICULAR",
      "session_id": "0BBB15A404B6BA1",
      "shipment":"Sedex",
      "shipment_value":"10.44",
      "payment_form":"Boleto - TrayCheckout",
      "Customer":{"type":"0",
      "name":"Nome do Cliente",
      "cpf":"00000000000",
      "email":"email@docliente.com",
      "rg":"00.000.000-X",
      "gender":"M",
      "phone":"1133330001",
      "CustomerAddress":[{
          "address":"Endereço do Cliente",
          "zip_code":"04001001",
          "number":"123",
          "complement":"Sala 123",
          "neighborhood":"Bairro do Cliente",
          "city":"Cidade do Cliente",
          "state":"SP",
          "country":"BRA",
          "type":"1"
          }
      ]},
      "ProductsSold":[{
          "product_id":1,
          "variant_id":12,
          "price":"42.90",
          "original_price":"42.90",
          "quantity":1  
        }
      ],
      "MarketplaceOrder": [{
          "marketplace_name": "Mercado Livre",
          "marketplace_seller_name": "1234567890",
          "marketplace_seller_id": "273480425",
          "marketplace_document": "0000000000000",
          "payment_responsible_document": "0000000000000",
          "marketplace_order_id": "4429804558",
          "marketplace_shipping_id": "40457395268",
          "marketplace_shipping_type": "me2",
          "marketplace_internal_status": "shipping"
        }
      ]
    }    
}

OBS: As Tabelas auxiliares estão logo a baixo do DELETE

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

Retorno de Sucesso:

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

Atualizar Dados do Pedido#put

Requisição para alterar os dados de um pedido. Deverá enviar o JSON com os dados do pedido para a alteração.

Código de Exemplo:

curl --location -g --request PUT 'https://{api_address}/orders/:id?access_token={{access_token}}' \
--data-urlencode '["Order"]["status_id"]=16' \
--data-urlencode '["Order"]["taxes"]=0.01' \
--data-urlencode '["Order"]["shipment"]=Sedex' \
--data-urlencode '["Order"]["shipment_value"]=5.58' \
--data-urlencode '["Order"]["discount"]=0.01' \
--data-urlencode '["Order"]["sending_code"]=123456' \
--data-urlencode '["Order"]["sending_date"]=2015-04-20' \
--data-urlencode '["Order"]["tracking_url"]=www.urlderastreio.com.br' \
--data-urlencode '["Order"]["store_note"]=Pedido em 1 vez de R$ 51,85 através do Boleto.' \
--data-urlencode '["Order"]["customer_note"]=' \
--data-urlencode '["Order"]["partner_id"]=2'

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('https://{api_address}/orders/:id?access_token={{access_token}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->addPostParameter(array(
  '["Order"]["status_id"]' => '16',
  '["Order"]["taxes"]' => '0.01',
  '["Order"]["shipment"]' => 'Sedex',
  '["Order"]["shipment_value"]' => '5.58',
  '["Order"]["discount"]' => '0.01',
  '["Order"]["sending_code"]' => '123456',
  '["Order"]["sending_date"]' => '2015-04-20',
  '["Order"]["store_note"]' => 'Pedido em 1 vez de R$ 51,85 através do Boleto.',
  '["Order"]["customer_note"]' => '',
  '["Order"]["partner_id"]' => '2'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

var client = new RestClient("https://{api_address}/orders/:id?access_token={{access_token}}");
client.Timeout = -1;
var request = new RestRequest(Method.PUT);
request.AddParameter("[\"Order\"][\"status_id\"]", "16");
request.AddParameter("[\"Order\"][\"taxes\"]", "0.01");
request.AddParameter("[\"Order\"][\"shipment\"]", "Sedex");
request.AddParameter("[\"Order\"][\"shipment_value\"]", "5.58");
request.AddParameter("[\"Order\"][\"discount\"]", "0.01");
request.AddParameter("[\"Order\"][\"sending_code\"]", "123456");
request.AddParameter("[\"Order\"][\"sending_date\"]", "2015-04-20");
request.AddParameter("[\"Order\"][\"store_note\"]", "Pedido em 1 vez de R$ 51,85 através do Boleto.");
request.AddParameter("[\"Order\"][\"customer_note\"]", "");
request.AddParameter("[\"Order\"][\"partner_id\"]", "2");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);