NAV
C# cURL Python

Introdução

Bem vindo a documentação da API Convertize.

Nossa API possui um conjunto de documentos que podem ser ultilizados como base, oferecendo recursos para controlar, integrar seu e-commerce com qualquer sistema, de forma rapida e fácil.

Ambiente Produção: https://api.convertize.com.br/

{ENVIRONMENT}: Nome dado para o ambiente do cliente junto a Convertize últlizado em todas as requisições da API

Para executar uma operação, combine a URL base do ambiente com a URL do {ENVIRONMENT} com a URL da operação desejada e envie utilizando o verbo HTTP conforme descrito na operação.

Exemplo: {URL_BASE}/{ENVIRONMENT}/{URL_OPERACAO}

Autenticação

Exemplo de autenticação:

import requests

r = requests.get('api_endpoint_here', headers={
  'Authorization': 'Token %s' % API_KEY
})
curl "api_endpoint_here"
  -H "Authorization: Token API_KEY"
using RestSharp;
var client = new RestClient("api_endpoint_here");

var request = new RestRequest("request_path");
request.Method = Method.GET;
request.AddHeader("Authorization", "Token " + API_KEY);

var response = client.Execute(request);

Certifique-se de substituir API_KEY com a sua chave de acesso.

Para obter uma chave de acesso a nossa API envie um email para dev@convertize.com.br.

Nossa API espera uma chave de acesso que deverá ser incluida em todas as solicitações, dentro da HEAD da solicitação conforme abaixo:

Authorization: Token API_KEY

Paginação

Nossa API trabalha com paginação de objetos, o limite de objetos por requisição é 100 por página, confome modelo ao lado.

Descrição dos parametros de retorno da páginação

Parametro Descrição
count Quantidade de páginas
next Proxima página, null = Última página
previous Página anterior, null = Primeira página
results Lista de objetos
{
    "count": 5,
    "next": "api_endpoint_here?page=2",
    "previous": null,
    "results": [
    ]
}

Mensagens

Sucesso

Nossa API usa os códigos de sucesso abaixo:

Error Code Meaning Descrição
200 OK OK
201 Created Objeto criado
202 Accepted Requisição aceita

Erros

Nossa API usa os códigos de erros abaixo:

Error Code Meaning Descrição
400 Bad Request Requisição inválida
401 Unauthorized Chave de API inválida
403 Forbidden Acesso proibido
404 Not Found Não econtrado
405 Method Not Allowed Método não permitido
406 Not Acceptable Formato da requisição inválido
410 Gone Esta função foi removida de nossos servidores
418 I’m a teapot
429 Too Many Requests Você esta fazendo muitas requisições em nossos servidores! Diminua!
500 Internal Server Error Problemas com nossos servidores. Tente novamente mais tarde.
503 Service Unavailable Nossos servidores estão passando por manutenção. Tente novamente mais tarde.

Clientes

Lista

Lista de Clientes

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/"
  -H "Authorization: Token API_KEY"
using RestSharp;
var client = new RestClient("https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/");

var request = new RestRequest("/customers/");
request.Method = Method.GET;
request.AddHeader("Authorization", "Token " + API_KEY);

var response = client.Execute(request);

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 40607,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/?page=2",
    "previous": null,
    "results": [
        {
            "uuid": "c9cf2a94-864f-4278-be72-077cf1fa6c67",
            "id": 138468,
            "reference_code": null,
            "email": "contato@convertize.com.br",
            "name": "Convertize E-Commerce",
            "blocked": false,
            "newsletter": 1,
            "zipcode": null,
            "address": null,
            "number": null,
            "neighborhood": null,
            "complement": null,
            "city": null,
            "state": null,
            "phone1": null,
            "phone2": null,
            "reference": null,
            "city_id": null,
            "code_ibge": null,
            "add_date": "2017-08-18T14:04:04.826000",
            "change_date": "2017-08-18T14:04:04.826020",
            "limit_credit": null,
            "balance_of_credit": null
        }
    ]
}

HTTP Request

Filtros via Query Parameters

Parameter Description
uuid UUID do cliente
id ID do cliente
email E-mail
document Documento PF
corporate_document Documento PJ
reference_code Código de referência no ERP
newsletter Filtro pelo campo newsletter
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
uuid * * UUID - UUID do cliente
id * * Int4 - ID do cliente
reference_code Varchar 64 Código de referência do cliente no ERP
email * * Varchar 255 E-mail do cliente
name Varchar 255 Nome do cliente
blocked Boolean 1 Indica se esta bloqueado default = false
newsletter Int4 - Indica se o cliente quer receber newsletter (1 = SIM, 2 = NÃO, 0 = NÃO)
zipcode Varchar 9 CEP
address Varchar 100 Endereço
number Varchar 100 Número
neighborhood Varchar 100 Bairro
complement Varchar 100 Complemento
city Varchar 100 Cidade
state Varchar 2 Estado
phone1 Varchar 20 Telefone residencial
phone2 Varchar 20 Telefone celular
reference Varchar 255 Ponto de Referencia
city_id Varchar 50 ID da cidade
code_ibge Varchar 50 Código do IBGE da cidade
limit_credit Numeric 10,2 Limite de Crédito
balance_of_credit Numeric 10,2 Saldo de Crédito

Detalhes

HTTP Request

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/{ID}/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/customers/{ID}/"
  -H "Authorization: Token API_KEY"
using RestSharp;
var client = new RestClient("https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/");

var request = new RestRequest("/customers/{ID}/");
request.Method = Method.GET;
request.AddHeader("Authorization", "Token " + API_KEY);

var response = client.Execute(request);

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "uuid": "c9cf2a94-864f-4278-be72-077cf1fa6c67",
    "id": 138468,
    "reference_code": null,
    "email": "contato@convertize.com.br",
    "name": "Convertize E-Commerce",
    "blocked": false,
    "newsletter": 1,
    "zipcode": null,
    "address": null,
    "number": null,
    "neighborhood": null,
    "complement": null,
    "city": null,
    "state": null,
    "phone1": null,
    "phone2": null,
    "reference": null,
    "city_id": null,
    "code_ibge": null,
    "add_date": "2017-08-18T14:04:04.826000",
    "change_date": "2017-08-18T14:04:04.826020",
    "limit_credit": null,
    "balance_of_credit": null
}

URL Parameters

Parameter Description
ID ID relativo ao Cliente

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
uuid * * UUID - UUID do cliente
id * * Int4 - ID do cliente
reference_code Varchar 64 Código de referência do cliente no ERP
email * * Varchar 255 E-mail do cliente
name Varchar 255 Nome do cliente
blocked Boolean 1 Indica se esta bloqueado default = false
newsletter Int4 - Indica se o cliente quer receber newsletter (1 = SIM, 2 = NÃO, 0 = NÃO)
zipcode Varchar 9 CEP
address Varchar 100 Endereço
number Varchar 100 Número
neighborhood Varchar 100 Bairro
complement Varchar 100 Complemento
city Varchar 100 Cidade
state Varchar 2 Estado
phone1 Varchar 20 Telefone residencial
phone2 Varchar 20 Telefone celular
reference Varchar 255 Ponto de Referencia
city_id Varchar 50 ID da cidade
code_ibge Varchar 50 Código do IBGE da cidade
limit_credit Numeric 10,2 Limite de Crédito
balance_of_credit Numeric 10,2 Saldo de Crédito
limit_credit Numeric 10,2 Limite de Crédito
balance_of_credit Numeric 10,2 Saldo de Crédito

JWT Login

HTTP Request

import jwt

encoded = jwt.encode({'email': 'suporte@convertize.com.br'}, '{APP_KEY}', algorithm='HS256')

jwt.decode(encoded, '{APP_KEY}', algorithms=['HS256'])
// Para gerar um JWT Token, você deverá usar as seguintes informações
// payload, app_key e algorithm

// o payload é um objeto contendo algumas informações.

// Login via e-mail:
// payload['email'] = 'suporte@convertize.com.br'

// Login via documento:
// payload['document'] = '07576321000188'

// app_key é gerada pela equipe de suporte da Convertize ou pelo painel do Cliente
// algorithm sempre será o HS256

// Veja com usar em qualquer linguagem de promgramação em: https://jwt.io/
// Para gerar um JWT Token, você deverá usar as seguintes informações
// payload, app_key e algorithm

// o payload é um objeto contendo algumas informações.

// Login via e-mail:
// payload['email'] = 'suporte@convertize.com.br'

// Login via documento:
// payload['document'] = '07576321000188'

// app_key é gerada pela equipe de suporte da Convertize ou pelo painel do Cliente
// algorithm sempre será o HS256

// Veja com usar em qualquer linguagem de promgramação em: https://jwt.io/

O comando acima retonar um JSON conforme estrutura abaixo:

// O cliente será redirectionado para URI informada no parametro next

URL Parameters

Parameter Description
JWT_TOKEN JWT token gerado conforme documentação ao lado
app_id ID da applicação, gerada pela equipe de suporte da Convertize ou pelo painel do Cliente
next URI destino do cliente

Categorias

Lista

Lista de categorias

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/"
  -H "Authorization: Token API_KEY"
using RestSharp;
var client = new RestClient("https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/");

var request = new RestRequest("/categories/");
request.Method = Method.GET;
request.AddHeader("Authorization", "Token " + API_KEY);

var response = client.Execute(request);

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 188,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/4/",
            "id": 4,
            "parent": null,
            "_order": 2,
            "title": "Borracharia",
            "slug": "borracharia",
            "active": true,
            "add_date": "2014-07-24T09:39:34.660080",
            "change_date": "2016-10-06T13:13:00.845996",
            "meta_title": "Borracharia - Materiais para Borracharia",
            "meta_description": "Grande variedade em ferramentas para Borracharia. Compre agora suas ferramentas para Borracharia, aproveite as melhores marcas e modelos que temos para oferecer. Acesse!",
            "meta_keywords": "borracharia",
            "inherit_template": false,
            "global_code": null,
            "lft": 1,
            "rght": 36,
            "tree_id": 2,
            "level": 0
        },
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/74/",
            "id": 74,
            "parent": 4,
            "_order": 65,
            "title": "Câmara de Ar",
            "slug": "borracharia/camara-de-ar",
            "active": true,
            "add_date": "2014-09-11T14:19:23.997496",
            "change_date": "2014-12-26T16:38:32.426313",
            "meta_title": "",
            "meta_description": "",
            "meta_keywords": "",
            "inherit_template": false,
            "global_code": null,
            "lft": 2,
            "rght": 3,
            "tree_id": 2,
            "level": 1
        }
    ]
}

HTTP Request

Filtros via Query Parameters

Parameter Description
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da categoria
title * Varchar 500 Título
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
parent Int4 - ID da categoria pai
meta_title Varchar 255 Titulo da categoria para SEO
meta_description Varchar 255 Descrição da categoria para SEO
inherit_template Boolean 1 Herdar template do pai
meta_keywords Varchar 255 Keywords da categoria para SEO separadas por “,”
global_code Varchar 500 Código da categoria Global (Google)

Detalhes

HTTP Request

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/{ID}/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/{ID}/"
  -H "Authorization: Token API_KEY"
using RestSharp;
var client = new RestClient("https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/");

var request = new RestRequest("/categories/{ID}/");
request.Method = Method.GET;
request.AddHeader("Authorization", "Token " + API_KEY);

var response = client.Execute(request);

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/74/",
    "id": 74,
    "parent": 4,
    "_order": 65,
    "title": "Câmara de Ar",
    "slug": "borracharia/camara-de-ar",
    "active": true,
    "add_date": "2014-09-11T14:19:23.997496",
    "change_date": "2014-12-26T16:38:32.426313",
    "meta_title": "",
    "meta_description": "",
    "meta_keywords": "",
    "inherit_template": false,
    "global_code": null,
    "lft": 2,
    "rght": 3,
    "tree_id": 2,
    "level": 1
}

URL Parameters

Parameter Description
ID ID relativo a categoria

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da categoria
title * Varchar 500 Título
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
parent Int4 - ID da categoria pai
meta_title Varchar 255 Titulo da categoria para SEO
meta_description Varchar 255 Descrição da categoria para SEO
inherit_template Boolean 1 Herdar template do pai
meta_keywords Varchar 255 Keywords da categoria para SEO separadas por “,”
global_code Varchar 500 Código da categoria Global (Google)

Criação

HTTP Request

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "title": "TITULO",
    "active": true,
    "meta_title": "TITULO SEO",
    "meta_description": "DESCRICAO SEO",
    "meta_keywords": "KEYWORDS SEO",
    "inherit_template": false
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/74/",
    "id": 74,
    "parent": null,
    "_order": 65,
    "title": "TITULO",
    "slug": "teste",
    "active": true,
    "add_date": "2014-09-11T14:19:23.997496",
    "change_date": "2014-12-26T16:38:32.426313",
    "meta_title": "TITULO SEO",
    "meta_description": "DESCRICAO SEO",
    "meta_keywords": "KEYWORDS SEO",
    "inherit_template": false,
    "global_code": null,
    "lft": 2,
    "rght": 3,
    "tree_id": 2,
    "level": 1
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da categoria
title * Varchar 500 Título
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
parent Int4 - ID da categoria pai
meta_title Varchar 255 Titulo da categoria para SEO
meta_description Varchar 255 Descrição da categoria para SEO
inherit_template Boolean 1 Herdar template do pai
meta_keywords Varchar 255 Keywords da categoria para SEO separadas por “,”
global_code Varchar 500 Código da categoria Global (Google)

Alteração

HTTP Request

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/{ID}/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/{ID}/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/74/",
    "id": 74,
    "parent": 4,
    "_order": 65,
    "title": "TITULO",
    "slug": "teste",
    "active": true,
    "add_date": "2014-09-11T14:19:23.997496",
    "change_date": "2014-12-26T16:38:32.426313",
    "meta_title": "TITULO SEO",
    "meta_description": "DESCRICAO SEO",
    "meta_keywords": "KEYWORDS SEO",
    "inherit_template": false,
    "global_code": null,
    "lft": 2,
    "rght": 3,
    "tree_id": 2,
    "level": 1
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/categories/74/",
    "id": 74,
    "parent": 4,
    "_order": 65,
    "title": "TITULO",
    "slug": "teste",
    "active": true,
    "add_date": "2014-09-11T14:19:23.997496",
    "change_date": "2014-12-26T16:38:32.426313",
    "meta_title": "TITULO SEO",
    "meta_description": "DESCRICAO SEO",
    "meta_keywords": "KEYWORDS SEO",
    "inherit_template": false,
    "global_code": null,
    "lft": 2,
    "rght": 3,
    "tree_id": 2,
    "level": 1
}

URL Parameters

Parameter Description
ID ID relativo a categoria

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da categoria
title * Varchar 500 Título
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
parent Int4 - ID da categoria pai
meta_title Varchar 255 Titulo da categoria para SEO
meta_description Varchar 255 Descrição da categoria para SEO
inherit_template Boolean 1 Herdar template do pai
meta_keywords Varchar 255 Keywords da categoria para SEO separadas por “,”
global_code Varchar 500 Código da categoria Global (Google)

Marcas

Lista

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 135,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/735/",
            "id": 735,
            "title": "ACR",
            "slug": "acr",
            "active": true,
            "description": "",
            "keywords": "",
            "add_date": "2014-08-01T16:27:17.913597",
            "change_date": "2014-08-01T16:27:17.913621",
            "image": null
        },
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/784/",
            "id": 784,
            "title": "ASICS",
            "slug": "asics",
            "active": true,
            "description": "",
            "keywords": "",
            "add_date": "2015-11-11T18:41:45.807927",
            "change_date": "2016-02-05T14:23:11.535834",
            "image": "https://api.convertize.com.br/{ENVIRONMENT}/products/brands/2016/2_0UfItQF.jpg"
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID da marca
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da marca
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
description Varchar 255 Descrição da marca para SEO
keywords Varchar 255 Keywords da marca para SEO separadas por “,”
image Varchar 100 URL da imagem

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/784/",
    "id": 784,
    "title": "ASICS",
    "slug": "asics",
    "active": true,
    "description": "",
    "keywords": "",
    "add_date": "2015-11-11T18:41:45.807927",
    "change_date": "2016-02-05T14:23:11.535834",
    "image": "https://api.convertize.com.br/{ENVIRONMENT}/products/brands/2016/2_0UfItQF.jpg"
}

URL Parameters

Parameter Description
ID ID relativo a marca

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da marca
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
description Varchar 255 Descrição da marca para SEO
keywords Varchar 255 Keywords da marca para SEO separadas por “,”
image Varchar 100 URL da imagem

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/', headers={
  'Authorization': 'Token %s' % API_KEY,
}, files={
  'image': open('CAMINHO_LOCAL_DO_ARQUIVO', 'rb'),
}, data={
  'title': 'TESTE',
  'active': 'true'
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: multipart/form-data"
  -X POST 
  -F "title=TESTE" 
  -F "active=true" 
  -F "image=@CAMINHO_LOCAL_DO_ARQUIVO"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/790/",
    "id": 790,
    "title": "TESTE",
    "slug": "teste",
    "active": true,
    "description": null,
    "keywords": null,
    "add_date": "2016-10-07T19:06:06.076498",
    "change_date": "2016-10-07T19:06:06.076534",
    "image": "https://api.convertize.com.br/{ENVIRONMENT}/products/brands/2016/logo.png"
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da marca
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
description Varchar 255 Descrição da marca para SEO
keywords Varchar 255 Keywords da marca para SEO separadas por “,”
image Varchar 100 URL da imagem

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
}, files={
  'image': open('CAMINHO_LOCAL_DO_ARQUIVO', 'rb'),
}, data={
  'title': 'TESTE',
  'active': 'true'
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: multipart/form-data"
  -X PUT 
  -F "title=TESTE" 
  -F "active=true" 
  -F "image=@CAMINHO_LOCAL_DO_ARQUIVO"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/brands/790/",
    "id": 790,
    "title": "TESTE",
    "slug": "teste",
    "active": true,
    "description": null,
    "keywords": null,
    "add_date": "2016-10-07T19:06:06.076498",
    "change_date": "2016-10-07T19:06:06.076534",
    "image": "https://api.convertize.com.br/{ENVIRONMENT}/products/brands/2016/logo.png"
}

URL Parameters

Parameter Description
ID ID relativo a marca

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da marca
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
active Boolean 1 Indica se esta ativo default = true
description Varchar 255 Descrição da marca para SEO
keywords Varchar 255 Keywords da marca para SEO separadas por “,”
image Varchar 100 URL da imagem

Grade

Lista

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 41,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/1/",
            "id": 1,
            "title": "Esmerilhadeiras",
            "display": "radio",
            "reference_code": null,
            "add_date": "2014-07-24T09:44:23.173981",
            "change_date": "2014-07-24T09:53:45.519836"
        },
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/2/",
            "id": 2,
            "title": "Trenas",
            "display": "radio",
            "reference_code": null,
            "add_date": "2014-07-31T10:14:19.039051",
            "change_date": "2014-07-31T10:14:41.881381"
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID do produto
reference_code Código de referência ou código da grade no ERP
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da grade
title * Varchar 500 Titulo
display Varchar 50 Forma de display opções (radio, select, custom)
active Boolean 1 Indica se esta ativo default = true
reference_code Varchar 64 Código de referência ou código da grade no ERP

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/2/",
    "id": 2,
    "title": "Trenas",
    "display": "radio",
    "reference_code": null,
    "add_date": "2014-07-31T10:14:19.039051",
    "change_date": "2014-07-31T10:14:41.881381"
}

URL Parameters

Parameter Description
ID ID relativo a grade

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da grade
title * Varchar 500 Titulo
display Varchar 50 Forma de display opções (radio, select, custom)
active Boolean 1 Indica se esta ativo default = true
reference_code Varchar 64 Código de referência ou código da grade no ERP

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "title": "TITULO",
    "display": "radio",
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/2/",
    "id": 2,
    "title": "Trenas",
    "display": "radio",
    "reference_code": null,
    "add_date": "2014-07-31T10:14:19.039051",
    "change_date": "2014-07-31T10:14:41.881381"
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da grade
title * Varchar 500 Titulo
display Varchar 50 Forma de display opções (radio, select, custom)
active Boolean 1 Indica se esta ativo default = true
reference_code Varchar 64 Código de referência ou código da grade no ERP

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "title": "Trenas",
    "display": "radio"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/grids/2/",
    "id": 2,
    "title": "Trenas",
    "display": "radio",
    "reference_code": null,
    "add_date": "2014-07-31T10:14:19.039051",
    "change_date": "2014-07-31T10:14:41.881381"
}

URL Parameters

Parameter Description
ID ID relativo a grade

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da grade
title * Varchar 500 Titulo
display Varchar 50 Forma de display opções (radio, select, custom)
active Boolean 1 Indica se esta ativo default = true
reference_code Varchar 64 Código de referência ou código da grade no ERP

Grade - Opções

Lista

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 6,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/5/",
            "id": 5,
            "grid": 43,
            "position": 0,
            "title": "Cor",
            "slug": "cor",
            "filterable": false,
            "ungroup": false,
            "display": null,
            "reference_code": null,
            "add_date": "2015-11-11T18:06:14.024972",
            "change_date": "2015-11-11T18:06:14.024989"
        },
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/2/",
            "id": 2,
            "grid": 5,
            "position": 0,
            "title": "Tamanho",
            "slug": "tamanho",
            "filterable": false,
            "ungroup": false,
            "display": null,
            "reference_code": null,
            "add_date": "2014-08-18T16:58:42.012403",
            "change_date": "2014-08-18T17:03:43.902259"
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID da opção
reference_code Código de referência ou código da grade no ERP
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da opcao
grid * Int4 - ID da Grade
position Int2 - Ordem das opções
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
filterable Boolean 1 Define se a opção será filtravel (default = true)
ungroup Boolean 1 Define se a opção deverá ser desagrupada (default = false)
display Varchar 50 Forma de display opções (checkbox, color, size)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/2/",
    "id": 2,
    "grid": 5,
    "position": 0,
    "title": "Tamanho",
    "slug": "tamanho",
    "filterable": false,
    "ungroup": false,
    "display": null,
    "reference_code": null,
    "add_date": "2014-08-18T16:58:42.012403",
    "change_date": "2014-08-18T17:03:43.902259"
}

URL Parameters

Parameter Description
ID ID relativo a opção

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da opcao
grid * Int4 - ID da Grade
position Int2 - Ordem das opções
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
filterable Boolean 1 Define se a opção será filtravel (default = true)
ungroup Boolean 1 Define se a opção deverá ser desagrupada (default = false)
display Varchar 50 Forma de display opções (checkbox, color, size)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "title": "Tamanho",
    "filterable": false,
    "ungroup": false,
    "grid": 5
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/2/",
    "id": 2,
    "grid": 5,
    "position": 0,
    "title": "Tamanho",
    "slug": "tamanho",
    "filterable": false,
    "ungroup": false,
    "display": null,
    "reference_code": null,
    "add_date": "2014-08-18T16:58:42.012403",
    "change_date": "2014-08-18T17:03:43.902259"
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da opcao
grid * Int4 - ID da Grade
position Int2 - Ordem das opções
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
filterable Boolean 1 Define se a opção será filtravel (default = true)
ungroup Boolean 1 Define se a opção deverá ser desagrupada (default = false)
display Varchar 50 Forma de display opções (checkbox, color, size)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "title": "Tamanho",
    "filterable": false,
    "ungroup": false,
    "grid": 5
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/options/2/",
    "id": 2,
    "grid": 5,
    "position": 0,
    "title": "Tamanho",
    "slug": "tamanho",
    "filterable": false,
    "ungroup": false,
    "display": null,
    "reference_code": null,
    "add_date": "2014-08-18T16:58:42.012403",
    "change_date": "2014-08-18T17:03:43.902259"
}

URL Parameters

Parameter Description
ID ID relativo a opção

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da opcao
grid * Int4 - ID da Grade
position Int2 - Ordem das opções
title * Varchar 500 Titulo
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
filterable Boolean 1 Define se a opção será filtravel (default = true)
ungroup Boolean 1 Define se a opção deverá ser desagrupada (default = false)
display Varchar 50 Forma de display opções (checkbox, color, size)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Grade - Valores

Lista

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 20,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/14/",
            "id": 14,
            "option": 5,
            "position": 0,
            "value": "Azul",
            "color": "",
            "reference_code": null,
            "add_date": "2015-11-11T18:06:14.383121",
            "change_date": "2015-11-11T18:38:46.746944"
        },
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/15/",
            "id": 15,
            "option": 5,
            "position": 1,
            "value": "Limão",
            "color": "",
            "reference_code": null,
            "add_date": "2015-11-11T18:06:14.465148",
            "change_date": "2015-11-11T18:38:46.764939"
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID do valor
reference_code Código de referência ou código da grade no ERP
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor
option * Int4 - ID da opção
position Int2 - Ordem dos valores
value * Varchar 500 Titulo
color Varchar 255 #Hexadecimal - (separar por virgula caso haja mais de uma)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/15/",
    "id": 15,
    "option": 5,
    "position": 1,
    "value": "Limão",
    "color": "",
    "reference_code": null,
    "add_date": "2015-11-11T18:06:14.465148",
    "change_date": "2015-11-11T18:38:46.764939"
}

URL Parameters

Parameter Description
ID ID relativo ao valor

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor
option * Int4 - ID da opção
position Int2 - Ordem dos valores
value * Varchar 500 Titulo
color Varchar 255 #Hexadecimal - (separar por virgula caso haja mais de uma)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "value": "Azul",
    "option": 5
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/14/",
    "id": 14,
    "option": 5,
    "position": 0,
    "value": "Azul",
    "color": "",
    "reference_code": null,
    "add_date": "2015-11-11T18:06:14.383121",
    "change_date": "2015-11-11T18:38:46.746944"
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor
option * Int4 - ID da opção
position Int2 - Ordem dos valores
value * Varchar 500 Titulo
color Varchar 255 #Hexadecimal - (separar por virgula caso haja mais de uma)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "value": "Azul",
    "option": 5
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/values/14/",
    "id": 14,
    "option": 5,
    "position": 0,
    "value": "Azul",
    "color": "",
    "reference_code": null,
    "add_date": "2015-11-11T18:06:14.383121",
    "change_date": "2015-11-11T18:38:46.746944"
}

URL Parameters

Parameter Description
ID ID relativo ao valor

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor
option * Int4 - ID da opção
position Int2 - Ordem dos valores
value * Varchar 500 Titulo
color Varchar 255 #Hexadecimal - (separar por virgula caso haja mais de uma)
reference_code Varchar 64 Código de referência ou código da grade no ERP

Grade - Especificações

Lista

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 5,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/?page=2",
    "previous": null,
    "results": [
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/4/",
            "id": 4,
            "grid": 8,
            "title": "Encaixe",
            "filterable": true,
            "required": false,
            "position": 0,
            "add_date": "2014-08-26T19:00:31.335595",
            "change_date": "2014-12-09T20:23:21.908761"
        },
        {
            "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/2/",
            "id": 2,
            "grid": 1,
            "title": "Rotação",
            "filterable": true,
            "required": false,
            "position": 0,
            "add_date": "2014-07-24T09:53:45.523049",
            "change_date": "2014-07-24T09:53:45.523070"
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID da especificação
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da especificação
grid * Int4 - Código da grade
title * Varchar 500 Titulo
filterable Boolean 1 Define se a opção será filtravel (default = true)
required Boolean 1 Define se a opção sera requerida (default = false)
position Int2 - Ordem das especificações

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/2/",
    "id": 2,
    "grid": 1,
    "title": "Rotação",
    "filterable": true,
    "required": false,
    "position": 0,
    "add_date": "2014-07-24T09:53:45.523049",
    "change_date": "2014-07-24T09:53:45.523070"
}

URL Parameters

Parameter Description
ID ID relativo a especificação

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da especificação
grid * Int4 - Código da grade
title * Varchar 500 Titulo
filterable Boolean 1 Define se a opção será filtravel (default = true)
required Boolean 1 Define se a opção sera requerida (default = false)
position Int2 - Ordem das especificações

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
  "grid": 1,
  "title": "Rotação"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/2/",
    "id": 2,
    "grid": 1,
    "title": "Rotação",
    "filterable": true,
    "required": false,
    "position": 0,
    "add_date": "2014-07-24T09:53:45.523049",
    "change_date": "2014-07-24T09:53:45.523070"
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da especificação
grid * Int4 - Código da grade
title * Varchar 500 Titulo
filterable Boolean 1 Define se a opção será filtravel (default = true)
required Boolean 1 Define se a opção sera requerida (default = false)
position Int2 - Ordem das especificações

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
  "grid": 1,
  "title": "Rotação"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "url": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/specifications/2/",
    "id": 2,
    "grid": 1,
    "title": "Rotação",
    "filterable": true,
    "required": false,
    "position": 0,
    "add_date": "2014-07-24T09:53:45.523049",
    "change_date": "2014-07-24T09:53:45.523070"
}

URL Parameters

Parameter Description
ID ID relativo a especificação

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da especificação
grid * Int4 - Código da grade
title * Varchar 500 Titulo
filterable Boolean 1 Define se a opção será filtravel (default = true)
required Boolean 1 Define se a opção sera requerida (default = false)
position Int2 - Ordem das especificações

Produtos

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do produto
category Int4 - ID da categoria
similar_category Array(Int4) - ID`s das categorias similares
brand Int4 - ID da marca
grid Int4 - ID da grade
suggestions Array(Int4) - ID`s dos produtos como sugestão
similars Array(Int4) - ID`s dos produtos similares
accessories Array(Int4) - ID`s dos produtos como acessórios
title * Varchar 255 Titulo do produto para SEO
slug * Varchar 2000 Slug (url), caso vazio o sistema gera automaticamente
meta_title Varchar 255 Titulo da categoria para SEO
description Varchar 255 Descrição da categoria para SEO
keywords Varchar 255 Keywords da categoria para SEO separadas por “,”
name Varchar 500 Nome do produto no ERP
upc * Varchar 64 Código de código UPC ou SKU
fiscal_code Varchar 64 Código classificação fiscal
reference_code Varchar 64 Código de referência ou código da grade no ERP
available Boolean 1 Indica se o produto esta disponivel para venda default = false
status Int2 - Satus do produto (1 = Rascunho, 2 = Publicado) default = 1
details Text - Detalhes do produto em HTML

Lista

Lista de Produtos

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 1606,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/?page=2",
    "previous": null,
    "results": [
        {
            "id": 1053,
            "category": 36,
            "similar_category": [],
            "brand": 645,
            "grid": null,
            "suggestions": [
                1232,
                1242,
                1235,
                1236,
                1237
            ],
            "similars": [
                1064,
                1057,
                1058,
                1067,
                1068
            ],
            "accessories": [],
            "title": "Jogo de Chave Hexagonal 1/16\" a 1/2\" - 12 pçs - BELZER",
            "slug": "jogo-de-chave-hexagonal-1-16-a-1-2-12-pcs-belzer-1591",
            "description": "",
            "keywords": "chave allen,allen",
            "add_date": "2014-08-05T17:34:42.471833",
            "change_date": "2014-12-04T15:56:04.418662",
            "name": "Jogo de Chave Hexagonal 1/16 pol a 1/2 pol - 12 Peças - Ref: 220904 - BELZER",
            "upc": "1591",
            "fiscal_code": "",
            "reference_code": "",
            "available": true,
            "status": 2,
            "details": "<p><span style=\"font-size:16px;\"><span style=\"font-family:arial,helvetica,sans-serif;\"><strong>Jogo de Chave Hexagonal.</strong></span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Pasta pl&aacute;stica;</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Jogo composto por 12 pe&ccedil;as, sendo:</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">-&nbsp;1/16&quot; - 5/64&quot; - 3/32&quot; - 1/8&quot; - 5/32&quot; - 3/16&quot; - 7/32&quot; - 1/4&quot; - 5/16&quot; - 3/8&quot; - 7/16 - 1/2&quot;.</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Ref: 220904.</span></span></p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Marca: BELZER</span></span></p>\r\n"
        },
        {
            "id": 1196,
            "category": 21,
            "similar_category": [],
            "brand": 690,
            "grid": null,
            "suggestions": [
                1144,
                1147,
                1148,
                1143
            ],
            "similars": [
                1193,
                1163,
                1164,
                1165
            ],
            "accessories": [],
            "title": "Chave de Fenda 1/4x5 pol - LOYAL",
            "slug": "chave-de-fenda-14x5-pol-loyal",
            "description": "",
            "keywords": "",
            "add_date": "2014-09-13T08:42:33.150479",
            "change_date": "2014-09-13T09:05:50.237882",
            "name": "Chave de Fenda 1/4x5 pol - LOYAL",
            "upc": "000730",
            "fiscal_code": "",
            "reference_code": "",
            "available": true,
            "status": 2,
            "details": "<p>Chave Fenda loyal em a&ccedil;o carbono.<br />\r\nCabo em polipropileno.</p>\r\n"
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID do produto
reference_code Código de referência ou código da grade no ERP
upc Código de código UPC ou SKU
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 1053,
    "category": 36,
    "similar_category": [],
    "brand": 645,
    "grid": null,
    "suggestions": [
        1232,
        1242,
        1235,
        1236,
        1237
    ],
    "similars": [
        1064,
        1057,
        1058,
        1067,
        1068
    ],
    "accessories": [],
    "title": "Jogo de Chave Hexagonal 1/16\" a 1/2\" - 12 pçs - BELZER",
    "slug": "jogo-de-chave-hexagonal-1-16-a-1-2-12-pcs-belzer-1591",
    "description": "",
    "keywords": "chave allen,allen",
    "add_date": "2014-08-05T17:34:42.471833",
    "change_date": "2014-12-04T15:56:04.418662",
    "name": "Jogo de Chave Hexagonal 1/16 pol a 1/2 pol - 12 Peças - Ref: 220904 - BELZER",
    "upc": "1591",
    "fiscal_code": "",
    "reference_code": "",
    "available": true,
    "status": 2,
    "details": "<p><span style=\"font-size:16px;\"><span style=\"font-family:arial,helvetica,sans-serif;\"><strong>Jogo de Chave Hexagonal.</strong></span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Pasta pl&aacute;stica;</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Jogo composto por 12 pe&ccedil;as, sendo:</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">-&nbsp;1/16&quot; - 5/64&quot; - 3/32&quot; - 1/8&quot; - 5/32&quot; - 3/16&quot; - 7/32&quot; - 1/4&quot; - 5/16&quot; - 3/8&quot; - 7/16 - 1/2&quot;.</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Ref: 220904.</span></span></p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Marca: BELZER</span></span></p>\r\n"
}

URL Parameters

Parameter Description
ID ID relativo ao produto

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "id": 1053,
    "category": 36,
    "similar_category": [],
    "brand": 645,
    "suggestions": [
        1232,
        1242,
        1235,
        1236,
        1237
    ],
    "similars": [
        1064,
        1057,
        1058,
        1067,
        1068
    ],
    "title": "Jogo de Chave Hexagonal 1/16\" a 1/2\" - 12 pçs - BELZER",
    "slug": "jogo-de-chave-hexagonal-1-16-a-1-2-12-pcs-belzer-1591",
    "keywords": "chave allen,allen",
    "add_date": "2014-08-05T17:34:42.471833",
    "change_date": "2014-12-04T15:56:04.418662",
    "name": "Jogo de Chave Hexagonal 1/16 pol a 1/2 pol - 12 Peças - Ref: 220904 - BELZER",
    "upc": "1591",
    "available": true,
    "status": 2,
    "details": "<p><span style=\"font-size:16px;\"><span style=\"font-family:arial,helvetica,sans-serif;\"><strong>Jogo de Chave Hexagonal.</strong></span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Pasta pl&aacute;stica;</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Jogo composto por 12 pe&ccedil;as, sendo:</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">-&nbsp;1/16&quot; - 5/64&quot; - 3/32&quot; - 1/8&quot; - 5/32&quot; - 3/16&quot; - 7/32&quot; - 1/4&quot; - 5/16&quot; - 3/8&quot; - 7/16 - 1/2&quot;.</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Ref: 220904.</span></span></p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Marca: BELZER</span></span></p>\r\n"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 1053,
    "category": 36,
    "similar_category": [],
    "brand": 645,
    "grid": null,
    "suggestions": [
        1232,
        1242,
        1235,
        1236,
        1237
    ],
    "similars": [
        1064,
        1057,
        1058,
        1067,
        1068
    ],
    "accessories": [],
    "title": "Jogo de Chave Hexagonal 1/16\" a 1/2\" - 12 pçs - BELZER",
    "slug": "jogo-de-chave-hexagonal-1-16-a-1-2-12-pcs-belzer-1591",
    "description": "",
    "keywords": "chave allen,allen",
    "add_date": "2014-08-05T17:34:42.471833",
    "change_date": "2014-12-04T15:56:04.418662",
    "name": "Jogo de Chave Hexagonal 1/16 pol a 1/2 pol - 12 Peças - Ref: 220904 - BELZER",
    "upc": "1591",
    "fiscal_code": "",
    "reference_code": "",
    "available": true,
    "status": 2,
    "details": "<p><span style=\"font-size:16px;\"><span style=\"font-family:arial,helvetica,sans-serif;\"><strong>Jogo de Chave Hexagonal.</strong></span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Pasta pl&aacute;stica;</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Jogo composto por 12 pe&ccedil;as, sendo:</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">-&nbsp;1/16&quot; - 5/64&quot; - 3/32&quot; - 1/8&quot; - 5/32&quot; - 3/16&quot; - 7/32&quot; - 1/4&quot; - 5/16&quot; - 3/8&quot; - 7/16 - 1/2&quot;.</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Ref: 220904.</span></span></p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Marca: BELZER</span></span></p>\r\n"
}

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "category": 36,
    "similar_category": [],
    "brand": 645,
    "suggestions": [
        1232,
        1242,
        1235,
        1236,
        1237
    ],
    "similars": [
        1064,
        1057,
        1058,
        1067,
        1068
    ],
    "title": "Jogo de Chave Hexagonal 1/16\" a 1/2\" - 12 pçs - BELZER",
    "slug": "jogo-de-chave-hexagonal-1-16-a-1-2-12-pcs-belzer-1591",
    "keywords": "chave allen,allen",
    "add_date": "2014-08-05T17:34:42.471833",
    "change_date": "2014-12-04T15:56:04.418662",
    "name": "Jogo de Chave Hexagonal 1/16 pol a 1/2 pol - 12 Peças - Ref: 220904 - BELZER",
    "upc": "1591",
    "available": true,
    "status": 2,
    "details": "<p><span style=\"font-size:16px;\"><span style=\"font-family:arial,helvetica,sans-serif;\"><strong>Jogo de Chave Hexagonal.</strong></span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Pasta pl&aacute;stica;</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Jogo composto por 12 pe&ccedil;as, sendo:</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">-&nbsp;1/16&quot; - 5/64&quot; - 3/32&quot; - 1/8&quot; - 5/32&quot; - 3/16&quot; - 7/32&quot; - 1/4&quot; - 5/16&quot; - 3/8&quot; - 7/16 - 1/2&quot;.</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Ref: 220904.</span></span></p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Marca: BELZER</span></span></p>\r\n"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 1053,
    "category": 36,
    "similar_category": [],
    "brand": 645,
    "grid": null,
    "suggestions": [
        1232,
        1242,
        1235,
        1236,
        1237
    ],
    "similars": [
        1064,
        1057,
        1058,
        1067,
        1068
    ],
    "accessories": [],
    "title": "Jogo de Chave Hexagonal 1/16\" a 1/2\" - 12 pçs - BELZER",
    "slug": "jogo-de-chave-hexagonal-1-16-a-1-2-12-pcs-belzer-1591",
    "description": "",
    "keywords": "chave allen,allen",
    "add_date": "2014-08-05T17:34:42.471833",
    "change_date": "2014-12-04T15:56:04.418662",
    "name": "Jogo de Chave Hexagonal 1/16 pol a 1/2 pol - 12 Peças - Ref: 220904 - BELZER",
    "upc": "1591",
    "fiscal_code": "",
    "reference_code": "",
    "available": true,
    "status": 2,
    "details": "<p><span style=\"font-size:16px;\"><span style=\"font-family:arial,helvetica,sans-serif;\"><strong>Jogo de Chave Hexagonal.</strong></span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Pasta pl&aacute;stica;</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Jogo composto por 12 pe&ccedil;as, sendo:</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">-&nbsp;1/16&quot; - 5/64&quot; - 3/32&quot; - 1/8&quot; - 5/32&quot; - 3/16&quot; - 7/32&quot; - 1/4&quot; - 5/16&quot; - 3/8&quot; - 7/16 - 1/2&quot;.</span></span></p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Ref: 220904.</span></span></p>\r\n\r\n<p>&nbsp;</p>\r\n\r\n<p><span style=\"font-size:14px;\"><span style=\"font-family:arial,helvetica,sans-serif;\">Marca: BELZER</span></span></p>\r\n"
}

URL Parameters

Parameter Description
ID ID relativo a categoria

Produtos - Especificações

Lista

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 1845,
    "next": "https://api.convertize.com.br/emporiodaporcelana/api/1.0/products/specifications/?page=2",
    "previous": null,
    "results": [
        {
            "url": "/api/1.0/products/specifications/220/",
            "id": 220,
            "product": 92,
            "specification": 2,
            "value": "Waves",
            "value_as_float": null,
            "add_date": "2018-10-27T12:54:12.531948",
            "change_date": "2018-10-27T12:54:37.644119"
        },
        {
            "url": "/api/1.0/products/specifications/250/",
            "id": 250,
            "product": 446,
            "specification": 2,
            "value": "Colibri",
            "value_as_float": null,
            "add_date": "2018-11-02T13:41:10.200595",
            "change_date": "2018-11-02T13:42:23.529897"
        }
    ]
}

HTTP Request

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID do valor da especificação
product Filtro pelo ID do produto
specification Filtro pelo ID da especificação
value Filtro pelo Valor da especificação
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor da especificação
specification * Int4 - Código da grade
product * Int4 - Código do produto
value * Varchar 500 Titulo

Detalhes

HTTP Request

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 250,
    "product": 446,
    "specification": 2,
    "value": "Colibri",
    "value_as_float": null,
    "add_date": "2018-11-02T13:41:10.200595",
    "change_date": "2018-11-02T13:42:23.529897"
}

URL Parameters

Parameter Description
ID ID relativo ao valor da especificação

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor da especificação
specification * Int4 - Código da grade
product * Int4 - Código do produto
value * Varchar 500 Titulo

Criação

HTTP Request

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0//specifications/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "product": 446,
    "specification": 2,
    "value": "Colibri"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 250,
    "product": 446,
    "specification": 2,
    "value": "Colibri",
    "value_as_float": null,
    "add_date": "2018-11-02T13:41:10.200595",
    "change_date": "2018-11-02T13:42:23.529897"
}

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor da especificação
specification * Int4 - Código da grade
product * Int4 - Código do produto
value * Varchar 500 Titulo

Alteração

HTTP Request

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/products/specifications/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "product": 446,
    "specification": 2,
    "value": "Colibri"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 250,
    "product": 446,
    "specification": 2,
    "value": "Colibri",
    "value_as_float": null,
    "add_date": "2018-11-02T13:41:10.200595",
    "change_date": "2018-11-02T13:42:23.529897"
}

URL Parameters

Parameter Description
ID ID relativo ao valor da especificação

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do valor da especificação
specification * Int4 - Código da grade
product * Int4 - Código do produto
value * Varchar 500 Titulo

SKU`s

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do SKU
product Int4 - ID da categoria
title Varchar 255 Titulo do SKU
ean_13 Varchar 255 EAN13 ou Código de barras
reference_code Varchar 64 Código de referência ou código da grade no ERP
weight Numeric 10,3 Peso
height Numeric 10,3 Altura
width Numeric 10,3 Largura
depth Numeric 10,3 Profundidade
cost_price Numeric 10,2 Preço de Custo
unit_price Numeric 10,2 Preço de Venda
sale_price Numeric 10,2 Preço de Venda Promocional
stock Int4 - Estoque
reserves_stock Int4 - Estoque Reserva
minimum_stock Int4 - Estoque mínimo
max_buy Int4 - Quantidade máxima de compra
available Boolean 1 Indica se o SKU esta disponivel para venda default = true
default Boolean 1 Indica se o SKU é o principal default = false
image Int4 - ID da Imagem
options Array(Int4) - ID`s dos valores das opções do SKU
availability Int4 - Disponibilidade do SKU ou Tempo de manuseio do produto
sell_out_of_stock Boolean 1 Vender SKU sem estoque default = False

Lista

Lista de SKU`s

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1699,
            "title": null,
            "ean_13": null,
            "reference_code": null,
            "weight": "0.000",
            "height": null,
            "width": null,
            "depth": null,
            "cost_price": null,
            "unit_price": null,
            "sale_price": null,
            "stock": 0,
            "reserves_stock": 0,
            "minimum_stock": 0,
            "max_buy": null,
            "available": true,
            "default": false,
            "add_date": "2016-10-08T12:52:37.028820",
            "change_date": "2016-10-08T12:52:37.028856",
            "options": [
                21,
                17
            ],
            "availability": null,
            "sell_out_of_stock": false,
            "product": 1664,
            "image": null
        },
        {
            "id": 1700,
            "title": null,
            "ean_13": null,
            "reference_code": null,
            "weight": "0.000",
            "height": null,
            "width": null,
            "depth": null,
            "cost_price": null,
            "unit_price": null,
            "sale_price": null,
            "stock": 0,
            "reserves_stock": 0,
            "minimum_stock": 0,
            "max_buy": null,
            "available": true,
            "default": false,
            "add_date": "2016-10-08T12:52:37.286080",
            "change_date": "2016-10-08T12:52:37.286104",
            "options": [
                21,
                19
            ],
            "availability": null,
            "sell_out_of_stock": false,
            "product": 1664,
            "image": null
        }
    ]
}

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/

Filtros via Query Parameters

Parameter Description
id Filtro pelo ID do produto
reference_code Código de referência ou código da grade no ERP
ean_13 Filtro pelo EAN13 ou Código de barras
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
change_date__lte Filtro por data de alteração menor ou igual
change_date__gte Filtro por data de alteração maior ou igual

Detalhes

HTTP Request

GET https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/<ID>/

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 1699,
    "title": null,
    "ean_13": null,
    "reference_code": null,
    "weight": "0.000",
    "height": null,
    "width": null,
    "depth": null,
    "cost_price": null,
    "unit_price": null,
    "sale_price": null,
    "stock": 0,
    "reserves_stock": 0,
    "minimum_stock": 0,
    "max_buy": null,
    "available": true,
    "default": false,
    "add_date": "2016-10-08T12:52:37.028820",
    "change_date": "2016-10-08T12:52:37.028856",
    "options": [
        21,
        17
    ],
    "availability": null,
    "sell_out_of_stock": false,
    "product": 1664,
    "image": null
}

URL Parameters

Parameter Description
ID ID relativo ao SKU

Criação

HTTP Request

POST https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "id": 1699,
    "weight": "0.000",
    "stock": 0,
    "reserves_stock": 0,
    "minimum_stock": 0,
    "available": true,
    "default": false,
    "options": [
        21,
        17
    ],
    "sell_out_of_stock": false,
    "product": 1664
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 1699,
    "title": null,
    "ean_13": null,
    "reference_code": null,
    "weight": "0.000",
    "height": null,
    "width": null,
    "depth": null,
    "cost_price": null,
    "unit_price": null,
    "sale_price": null,
    "stock": 0,
    "reserves_stock": 0,
    "minimum_stock": 0,
    "max_buy": null,
    "available": true,
    "default": false,
    "add_date": "2016-10-08T12:52:37.028820",
    "change_date": "2016-10-08T12:52:37.028856",
    "options": [
        21,
        17
    ],
    "availability": null,
    "sell_out_of_stock": false,
    "product": 1664,
    "image": null
}

Alteração

HTTP Request

PUT https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/<ID>/

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/skus/<ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "id": 1699,
    "weight": "0.000",
    "stock": 0,
    "reserves_stock": 0,
    "minimum_stock": 0,
    "available": true,
    "default": false,
    "options": [
        21,
        17
    ],
    "sell_out_of_stock": false,
    "product": 1664
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 1699,
    "title": null,
    "ean_13": null,
    "reference_code": null,
    "weight": "0.000",
    "height": null,
    "width": null,
    "depth": null,
    "cost_price": null,
    "unit_price": null,
    "sale_price": null,
    "stock": 0,
    "reserves_stock": 0,
    "minimum_stock": 0,
    "max_buy": null,
    "available": true,
    "default": false,
    "add_date": "2016-10-08T12:52:37.028820",
    "change_date": "2016-10-08T12:52:37.028856",
    "options": [
        21,
        17
    ],
    "availability": null,
    "sell_out_of_stock": false,
    "product": 1664,
    "image": null
}

URL Parameters

Parameter Description
ID ID relativo ao SKU

Pedidos

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID do pedido
reference_code Varchar 64 Código de referência no marketplace
erp_code Varchar 64 Código de referência ou código da grade no ERP
customer * Int4 - ID do cliente
billing_detail_name * Varchar 100 Nome do cliente
billing_detail_document * Varchar 100 Documento do cliente
billing_detail_address * Varchar 100 Endereço
billing_detail_number * Varchar 100 Número
billing_detail_complement * Varchar 100 Complemento
billing_detail_neighborhood * Varchar 100 Bairro
billing_detail_city * Varchar 100 Cidade
billing_detail_state * Varchar 100 Estado
billing_detail_postcode * Varchar 100 CEP
billing_detail_phone * Varchar 100 Telefone
billing_detail_email * Varchar 100 E-mail do cliente
shipping_detail_name * Varchar 100 Nome do cliente
shipping_detail_document * Varchar 100 Documento do cliente
shipping_detail_address * Varchar 100 Endereço
shipping_detail_number * Varchar 100 Número
shipping_detail_complement * Varchar 100 Complemento
shipping_detail_neighborhood * Varchar 100 Bairro
shipping_detail_city * Varchar 100 Cidade
shipping_detail_state * Varchar 100 Estado
shipping_detail_postcode * Varchar 100 CEP
shipping_detail_phone * Varchar 100 Telefone
shipping_detail_email * Varchar 100 E-mail do cliente
shipping_total * Numeric 10,2 Custo do envio
shipping_discount * Numeric 10,2 Desconto no envio
shipping_delivery_date * Date - Data de entrega
shipping_type * Varchar 50 Tipo de entrega
shipping_delivery_date * Date - Data de entrega
item_total * Numeric 10,2 Total do pedido em itens
discount_total * Numeric 10,2 Total de desconto
total * Numeric 10,2 Total do pedido
payment_method * Varchar 50 Forma de pagamento
institution * Varchar 50 Instituição Financeira
installments * Int4 50 Parcelas
captured Boolean 1 Informa se o pedido esta capturado
status * Varchar 50 Status do pedido
channel * Int4 50 Código do canal de compra
observation Text - Texto do observação
transaction_id Varchar 150 Código da transação
pan Varchar 100 PAN da transação
nsu Varchar 100 NSU da transação
card_mask Varchar 25 Cartão mascarado
ip_addrress Inet - IP da transação
weddinglist Int4 - ID da lista de presente
seller Int4 - ID do vendedor
items * List - Lista de items do pedido
items.order * Int4 - ID do pedido
items.sku * Int4 - ID do item
items.description * Varchar 200 ID do item
items.quantity * Int4 - Quantidade do item
items.unit_price * Numeric 10,2 Preço unitário
items.total_price * Numeric 10,2 Preço total
items.discount * Numeric 10,2 Desconto no item
items.is_gift * Boolean 1 Informa se o item é presente
trackers List - Lista de códigos de rastreio
trackers.id * Int4 - ID do código de rastreio
trackers.order * Int4 - ID do pedido
trackers.code * Varchar 100 Código do Rastreio
trackers.status * Varchar 50 Status do pedido
invoices List - Lista de notas fiscais
trackers.id * Int4 - ID da nota fiscal
trackers.order * Int4 - ID do pedido
trackers.key * Varchar 100 Código da Nota Fiscal
trackers.date_issue * Datetime - Data de emissão (yyyy-mm-ddTHH:ii:ss)
trackers.series * Varchar 50 Serie da Nota Fiscal
trackers.total * Numeric 10,2 Total da Nota Fiscal

Lista

Lista de pedidos

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "count": 114,
    "next": "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/?page=2",
    "previous": null,
    "results": [
        {
            "id": 172,
            "reference_code": null,
            "erp_code": null,
            "customer": 1,
            "billing_detail_name": "TESTE NOME",
            "billing_detail_document": "12312312312",
            "billing_detail_address": "R BERNARDINO DE CAMPOS",
            "billing_detail_number": "1001",
            "billing_detail_complement": "SALA 1001",
            "billing_detail_neighborhood": "CENTRO",
            "billing_detail_city": "RIBEIRÃO PRETO",
            "billing_detail_state": "SP",
            "billing_detail_postcode": "14015130",
            "billing_detail_phone": "(16) 30757676",
            "billing_detail_email": "dev@convertize.com.br",
            "shipping_detail_name": "TESTE NOME",
            "shipping_detail_document": "12312312312",
            "shipping_detail_address": "R BERNARDINO DE CAMPOS",
            "shipping_detail_number": "1001",
            "shipping_detail_complement": "SALA 1001",
            "shipping_detail_neighborhood": "CENTRO",
            "shipping_detail_city": "RIBEIRÃO PRETO",
            "shipping_detail_state": "SP",
            "shipping_detail_postcode": "14015130",
            "shipping_detail_phone": "(16) 30757676",
            "shipping_detail_email": "dev@convertize.com.br",
            "shipping_total": "13.50",
            "shipping_discount": "0.00",
            "shipping_delivery_date": "2016-08-05",
            "item_total": "260.00",
            "discount_total": "0.00",
            "total": "273.50",
            "payment_method": "Boleto",
            "institution": "Bancodobrasil",
            "installments": 1,
            "captured": false,
            "status": "PEN",
            "channel": 0,
            "observation": null,
            "transaction_id": null,
            "pan": null,
            "nsu": null,
            "card_mask": null,
            "ip_addrress": "127.0.0.1",
            "weddinglist": null,
            "seller": null,
            "add_date": "2016-07-26T17:06:11.408989",
            "update_date": "2016-07-26T17:06:20.554219",
            "items": [
                {
                    "order": 172,
                    "sku": 1694,
                    "description": "COMBO TESTE",
                    "quantity": 4,
                    "unit_price": "20.00",
                    "total_price": "80.00",
                    "discount": "0.00",
                    "delivery_time": null,
                    "shipping_type": null,
                    "is_gift": false
                },
                {
                    "order": 172,
                    "sku": 1693,
                    "description": "COMBO TESTE",
                    "quantity": 4,
                    "unit_price": "45.00",
                    "total_price": "180.00",
                    "discount": "0.00",
                    "delivery_time": null,
                    "shipping_type": null,
                    "is_gift": false
                }
            ]
        },
        {
            "id": 171,
            "reference_code": null,
            "erp_code": null,
            "customer": 1,
            "billing_detail_name": "TESTE NOME",
            "billing_detail_document": "12312312312",
            "billing_detail_address": "R BERNARDINO DE CAMPOS",
            "billing_detail_number": "1001",
            "billing_detail_complement": "SALA 1001",
            "billing_detail_neighborhood": "CENTRO",
            "billing_detail_city": "RIBEIRÃO PRETO",
            "billing_detail_state": "SP",
            "billing_detail_postcode": "14015130",
            "billing_detail_phone": "(16) 30757676",
            "billing_detail_email": "dev@convertize.com.br",
            "shipping_detail_name": "TESTE NOME",
            "shipping_detail_document": "12312312312",
            "shipping_detail_address": "R BERNARDINO DE CAMPOS",
            "shipping_detail_number": "1001",
            "shipping_detail_complement": "SALA 1001",
            "shipping_detail_neighborhood": "CENTRO",
            "shipping_detail_city": "RIBEIRÃO PRETO",
            "shipping_detail_state": "SP",
            "shipping_detail_postcode": "14015130",
            "shipping_detail_phone": "(16) 30757676",
            "shipping_detail_email": "dev@convertize.com.br",
            "shipping_total": "13.50",
            "shipping_discount": "0.00",
            "shipping_delivery_date": "2016-08-05",
            "item_total": "195.00",
            "discount_total": "0.00",
            "total": "208.50",
            "payment_method": "Boleto",
            "institution": "Bancodobrasil",
            "installments": 1,
            "captured": false,
            "status": "PEN",
            "channel": 0,
            "observation": null,
            "transaction_id": null,
            "pan": null,
            "nsu": null,
            "card_mask": null,
            "ip_addrress": "127.0.0.1",
            "weddinglist": null,
            "seller": null,
            "add_date": "2016-07-26T16:55:25.319729",
            "update_date": "2016-07-26T16:55:49.012298",
            "items": [
                {
                    "order": 171,
                    "sku": 1694,
                    "description": "COMBO TESTE",
                    "quantity": 3,
                    "unit_price": "20.00",
                    "total_price": "60.00",
                    "discount": "0.00",
                    "delivery_time": null,
                    "shipping_type": null,
                    "is_gift": false
                },
                {
                    "order": 171,
                    "sku": 1693,
                    "description": "COMBO TESTE",
                    "quantity": 3,
                    "unit_price": "45.00",
                    "total_price": "135.00",
                    "discount": "0.00",
                    "delivery_time": null,
                    "shipping_type": null,
                    "is_gift": false
                }
            ]
        }
    ]
}

HTTP Request

Filtros via Query Parameters

Parameter Description
id ID do pedido
reference_code Código de referência no marketplace
erp_code Código de referência no ERP
add_date__lte Filtro por data de criação menor ou igual
add_date__gte Filtro por data de criação maior ou igual
update_date__lte Filtro por data de alteração menor ou igual
update_date__gte Filtro por data de alteração maior ou igual

Detalhes

HTTP Request

import requests

r = requests.get('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/', headers={
  'Authorization': 'Token %s' % API_KEY
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/"
  -H "Authorization: Token API_KEY"

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 172,
    "reference_code": null,
    "erp_code": null,
    "customer": 1,
    "billing_detail_name": "TESTE NOME",
    "billing_detail_document": "12312312312",
    "billing_detail_address": "R BERNARDINO DE CAMPOS",
    "billing_detail_number": "1001",
    "billing_detail_complement": "SALA 1001",
    "billing_detail_neighborhood": "CENTRO",
    "billing_detail_city": "RIBEIRÃO PRETO",
    "billing_detail_state": "SP",
    "billing_detail_postcode": "14015130",
    "billing_detail_phone": "(16) 30757676",
    "billing_detail_email": "dev@convertize.com.br",
    "shipping_detail_name": "TESTE NOME",
    "shipping_detail_document": "12312312312",
    "shipping_detail_address": "R BERNARDINO DE CAMPOS",
    "shipping_detail_number": "1001",
    "shipping_detail_complement": "SALA 1001",
    "shipping_detail_neighborhood": "CENTRO",
    "shipping_detail_city": "RIBEIRÃO PRETO",
    "shipping_detail_state": "SP",
    "shipping_detail_postcode": "14015130",
    "shipping_detail_phone": "(16) 30757676",
    "shipping_detail_email": "dev@convertize.com.br",
    "shipping_total": "13.50",
    "shipping_discount": "0.00",
    "shipping_delivery_date": "2016-08-05",
    "item_total": "260.00",
    "discount_total": "0.00",
    "total": "273.50",
    "payment_method": "Boleto",
    "institution": "Bancodobrasil",
    "installments": 1,
    "captured": false,
    "status": "PEN",
    "channel": 0,
    "observation": null,
    "transaction_id": null,
    "pan": null,
    "nsu": null,
    "card_mask": null,
    "ip_addrress": "127.0.0.1",
    "weddinglist": null,
    "seller": null,
    "add_date": "2016-07-26T17:06:11.408989",
    "update_date": "2016-07-26T17:06:20.554219",
    "items": [
        {
            "order": 172,
            "sku": 1694,
            "description": "COMBO TESTE",
            "quantity": 4,
            "unit_price": "20.00",
            "total_price": "80.00",
            "discount": "0.00",
            "delivery_time": null,
            "shipping_type": null,
            "is_gift": false
        },
        {
            "order": 172,
            "sku": 1693,
            "description": "COMBO TESTE",
            "quantity": 4,
            "unit_price": "45.00",
            "total_price": "180.00",
            "discount": "0.00",
            "delivery_time": null,
            "shipping_type": null,
            "is_gift": false
        }
    ]
}

URL Parameters

Parameter Description
ID ID relativo ao pedido

Alteração de status

HTTP Request

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/status/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/status/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "status": "PEN"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "status": "PEN"
}

URL Parameters

Parameter Description
ID ID relativo ao pedido

Lista de status

Código Descrição
PEN Pedido Realizado com Sucesso
AADF Aguardando Análise
CEP Pagamento Recebido
PES Em Separação
ETP Entregue a Transportadora
PECS Entregue
PNA Pagamento não Aprovado
PEC Pagamento em Contestação
PCD Chargeback
PDV Pagamento Devolvido
PED Pagamento em Disputa
PDPN Pagamento Dísponível
CANM Cancelado

Código de Rastreio

HTTP Request Create

import requests

r = requests.put('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/trackers/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/trackers/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X PUT -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "code": "SW902295112BR",
    "status": "ETP"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 84,
    "order": 172,
    "code": "SW902295112BR",
    "status": "ETP",
    "add_date": "2016-10-11T16:10:38.626884",
    "update_date": "2016-10-11T16:10:38.626930"
}

URL Parameters

Parameter Description
ID ID relativo ao pedido

Lista de status

Código Descrição
PEN Pedido Realizado com Sucesso
AADF Aguardando Análise
CEP Pagamento Recebido
PES Em Separação
ETP Entregue a Transportadora
PECS Entregue
PNA Pagamento não Aprovado
PEC Pagamento em Contestação
PCD Chargeback
PDV Pagamento Devolvido
PED Pagamento em Disputa
PDPN Pagamento Dísponível
CANM Cancelado

HTTP Request Delete

import requests

r = requests.delete('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/trackers/<TRACKER_ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/trackers/<TRACKER_ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X DELETE

O comando acima retonar um HTTP STATUS:

Http Status: 204

URL Parameters

Parameter Description
ID ID relativo ao pedido
TRACKER_ID ID relativo ao código de rastreio

Nota Fiscal

Descrição dos campos

Campo Requerido Unico Tipo do Campo Max Caracteres Descrição
id * Int4 - ID da nota fiscal
order * Int4 - ID do pedido
reference_code Varchar 64 Código de referência da nota
key * Varchar 100 Chave da nota fiscal ou invoice
series * Varchar 50 Serie da nota fiscal
date_issue * Datetime - Data de emissão (yyyy-mm-ddTHH:ii:ss)
total * Numeric 10,2 Total da nota

HTTP Request Create

import requests

r = requests.post('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/invoices/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
}, data=<JSON>)

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/invoices/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X POST -d '<JSON>'

Exemplo < JSON > a ser enviado:

{
    "order": 172,
    "key": "12312312313212",
    "series": "123",
    "reference_code": "01",
    "date_issue": "1989-10-01T10:59:59",
    "total": "150.50"
}

O comando acima retonar um JSON conforme estrutura abaixo:

{
    "id": 9,
    "order": 172,
    "reference_code": "01",
    "key": "12312312313212",
    "series": "123",
    "date_issue": "1989-10-01T10:59:59",
    "total": "150.50",
    "add_date": "2016-10-11T16:35:44.614333",
    "update_date": "2016-10-11T16:35:44.614360"
}

URL Parameters

Parameter Description
ID ID relativo ao pedido

HTTP Request Delete

import requests

r = requests.delete('https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/trackers/<INVOICE_ID>/', headers={
  'Authorization': 'Token %s' % API_KEY,
  'Content-Type': 'application/json'
})

print r.status_code
print r.json()
curl "https://api.convertize.com.br/{ENVIRONMENT}/api/1.0/orders/<ID>/trackers/<INVOICE_ID>/"
  -H "Authorization: Token API_KEY"
  -H "Content-Type: application/json"
  -X DELETE

O comando acima retonar um HTTP STATUS:

Http Status: 204

URL Parameters

Parameter Description
ID ID relativo ao pedido
INVOICE_ID ID relativo a nota fiscal