API Irroba - Docs

Visão Geral

Comunicação

Toda a comunicação da API deverá ser realizada via JSON (JavaScript Object Notation - Notação de Objetos JavaScript), facilitando assim a comunicação dos dados. Dessa forma, recomendamos a utilização da header abaixo nas requisições (exceto em /getToken)

Content-Type: "application/json"

Token

Em todas as requisições é necessário a utilização do Token de autorização na header da requisição (exceto em /getToken).

Os Tokens são únicos e exclusivos para cada usuário em cada loja, portanto se desejar realizar a integração com mais de uma loja, é necessário solicitar um novo Usuário e Senha.

Caso o Token esteja incorreto, será retornado como 401 - Não autorizado.

{
  "success": "false",
  "error": "Invalid Key {{Authorization}}"
}

Os Tokens tem duração máxima de 30 minutos, dessa forma após esse período será necessário solicitar um novo Token.

Caso o Token esteja expirado, será retornado como 401 - Não autorizado.

{
  "success": "false",
  "error": "{{Authorization}} Expired"
}

Caso ainda não possua seu Usuário e Senha, entre em sua área administrativa: APS >> Usuários >> Usuário API

Limite de requisições

Plano	Limite
Bronze - R$120,00	30 requisições por minuto
Silver - R$170,00	60 requisições por minuto
Gold - R$230,00	90 requisições por minuto
Acima de R$330,00	120 requisições por minuto

Códigos de Resposta

200 - Sucesso. Não houve problemas na requisição

401 - Não autorizado. Provavelmente o Token informado está invalido ou expirado, entre em contato para mais informações.

404 - Não encontrado. Provavelmente o recurso em questão não existe no sistema.

422 - Entidade improcessável. O pedido foi bem formado, mas era incapaz de ser seguido devido a erros de semântica.

500 - Erro interno. Algo de errado pode ter ocorrido em nosso sistema, por favor contacte-nos informando o ocorrido.

Ordenando os dados

Em métodos onde é disponibilizado uma lista de informações, é possível ordenar, navegar pelas páginas, e até mesmo definir um limite desejado.

O limit deve ser utilizado para informar o limite desejado, lembrando que o limite máximo é de 100.

O page é utilizado para informar a página desejada, caso não seja informado será estabelecido o valor 1

Por sua vez o sort é utilizado para informar o parâmetro de ordenação, você pode verificar a disponibilidade de acordo com a tabela de cada grupo de métodos. Caso não seja informado será estabelecido o valor date_added

E finalmente o order define como a ordenação deve ser interpretada, ASC para ascendente e DESC para descendente, possibilitando assim mais versatilidade nas requisições. Caso não seja informado será estabelecido o valor DESC

Recomendações

Para facilitar nos testes, recomendamos a utilização do Postman ou do Advanced Rest Client, dessa forma você poderá realizar requisições antes de construir em sua aplicação e conseguirá entender melhor o fluxo da API.

- Download do Postman

- Download da Collection API Irroba para o Postman

- Download do Advanced Rest Client (Google Chrome)

- Download do Projeto API Irroba para o Advanced Rest Client

Token

/getToken

Método responsável por retornar o Token.

Deverá ser realizado uma requisição POST informando no corpo da requisição, seu usuário e senha.

POST https://api.irroba.com.br/v1/getToken

Requisição

Nome	Descrição	Formato
username	Usuário previamente disponibilizado	String
password	Senha previamente disponibilizado	String

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os pedidos retornados	Objeto em JSON
data authorization	O Token que você deverá utilizar nas requisições.	String

{
  "success": "true",
  "data": {
    "authorization": "SEU TOKEN"
  }
}

Banner

Tabela de possíveis ordenações

A baixo todos os filtros disponíveis para métodos que são listas de banners. Para utilizar basta através da URL informar o parâmetro sort. E através do parâmetro order informar o tipo de ordenação (ASC ou DESC). Caso os valores informados estejam incorretos, por padrão os valores são date_added e DESC respectivamente.

Nome	Descrição
banner_new_id	ID do Banner
name_banner	Nome do Banner
link_banner	Link ao clicar no banner
link_image	Imagem do banner dentro do sistema
position	Tipo de banner dentro do sistema
status	Estado atual do banner (Ativado = 1 / Desativado = 0)
date_start	Data em que o banner começará a ser exibido
date_end	Data em que o banner não será mais exibido
sort_order	Ordenação dentro do e-commerce (Menor para maior)
date_added	Data de adição do banner (Padrão ISO 8601)

/banner

Método responsável por retornar uma lista com informações dos Banners.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/banner

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data banner_new_id	ID do Banner	Numérico (int)
data name_banner	Nome do banner	String
data link_banner	Link para qual o banner redireciona	String
data position	Tipo do banner: - banner_full / Full Banner - banner_full_side / Banner lateral do Full Banner - banner_targe / Banner Tarja - banner_side / Banner Lateral	String
data status	Estado do Banner (Ativado = 1 / Desativado = 0)	String
data date_start	Data em que o banner começará a ser exibido	String
data date_end	Data em que o banner não será mais exibido	String
data sort_order	Ordenação dentro do e-commerce (Menor para maior)	String
data date_added	Data de adição do banner (Padrão ISO 8601)	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/banner?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
      {
            "banner_new_id": 88,
            "name_banner": "Mini-Banner-Teste",
            "link_banner": "",
            "link_image": "banner_minif131b7052d.png",
            "position": "banner_mini",
            "status": 0,
            "date_start": "2017-06-30",
            "date_end": "2018-06-30",
            "sort_order": 0,
            "date_added": "2017-06-30 13:56:14"
        },
        {
            "banner_new_id": 83,
            "name_banner": "Teste Auto Repair",
            "link_banner": "",
            "link_image": "banner_fulld9788a5c7b.jpg",
            "position": "banner_full",
            "status": 0,
            "date_start": "2017-03-31",
            "date_end": "2018-03-31",
            "sort_order": 0,
            "date_added": "2017-03-31 16:34:03"
        }
    ]
}

Banner V2

Tabela de possíveis ordenações

Nome	Descrição
name	Nome do Banner v2
status	Estado atual do banner v2 (Ativado = 1 / Desativado = 0)
date_start	Data em que o banner v2 começará a ser exibido
date_end	Data em que o banner v2 não será mais exibido
banner_type	Tipo do Banner v2
image_name	Nome da imagem
image	Imagem

/banner/v2

Método responsável por retornar uma lista com informações dos Banners V2.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/banner/v2

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data name	Nome do Banner V2	String
data status	Estado do Banner v2 (Ativado = 1 / Desativado = 0)	String
data date_start	Data em que o banner v2 começará a ser exibido	String
data date_end	Data em que o banner v2 não será mais exibido	String
data banner_type	Tipo do Banner v2	String
data banners image_name	Nome da imagem do banner v2	String
data banners image	imagem banner v2	String

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
        "previousPageUrl": null,
        "nextPageUrl": null,
        "firstItem": 1,
        "lastItem": 2
    },
    "data": [
        {
                "name": "Banner Desktop",
                "status": "1",
                "date_start": "",
                "date_end": "",
                "banner_type": "carousel"
                "banners": [
                    {
                        "image_name": "Páscoa",
                        "image": "https:\/\/img.site.com.br\/fit-in\/loja\/catalog\/banners-d2d\/banner-day2day-desktop-2.png"
                    }
                ]
            },
        ]
    }

Categories (Categorias)

Tabela de possíveis ordenações

A baixo todos os filtros disponíveis para métodos que são listas de categorias. Para utilizar basta através da URL informar o parâmetro sort. E através do parâmetro order informar o tipo de ordenação (ASC ou DESC). Caso os valores informados estejam incorretos, por padrão os valores são date_added e DESC respectivamente.

Nome	Descrição
category_id	ID da Categoria
image	Imagem atrelada a categoria
image_icon	Imagem ícone
parent_id	ID da categoria pai
sort_order	Ordenação (Menor para o maior)
status	Indica se a categoria está habilitada
date_added	Data que a categoria foi adicionada (Padrão ISO 8601)
language_id	Linguagem da descrição (2 padrão para Português)
name	Nome da categoria
description	Descrição da categoria
meta_title	Meta Título da categoria
meta_description	Meta Descrição da categoria
meta_keyword	Meta Keywords da categoria

/category

Método responsável por retornar uma lista com informações das categorias.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/category

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos as categorias retornadas	Objeto em JSON
data category_id	ID da Categoria	Numérico (int)
data image	Imagem atrelada a categoria	String
data image_icon	Imagem ícone	String
data parent_id	ID da categoria pai	Numérico (int)
data sort_order	Ordenação dentro do e-commerce (do menor para o maior)	Numérico (int)
data status	Estado da categoria (1 = Habilitado / 0 = Desabilitado)	Numérico (int)
data date_added	Data que o cliente foi adicionado (Padrão ISO 8601)	String
data category_description	Objeto com informações descritivas da categoria	Objeto em JSON
data category_description language_id	Linguagem da descrição (2 padrão para Português)	Numérico (int)
data category_description name	Nome da categoria	String
data category_description description	Descrição da categoria (Pode conter ou não Html)	String
data category_description meta_title	Meta Título da categoria, usado principalmente para motores de busca	String
data category_description meta_description	Meta Descrição da categoria, usado principalmente para motores de busca	String
data category_description meta_keyword	Meta Keywords da categoria, usado principalmente para motores de busca	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/category?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
      {
            "category_id": 248,
            "image": "",
            "image_icon": "https:\/\/img.com.br\/fit-in\/shoe\/\/catalog\/icones\/daytoday\/05.png",
            "parent_id": 247,
            "sort_order": 0,
            "status": 1,
            "date_added": "2017-05-30 10:49:32",
            "category_description": [
                {
                    "language_id": 2,
                    "name": "Social Feminino",
                    "description": "",
                    "meta_title": "",
                    "meta_description": "",
                    "meta_keyword": ""
                }
            ]
        },
        {
            "category_id": 247,
            "image": "",
            "parent_id": 0,
            "sort_order": 0,
            "status": 1,
            "date_added": "2017-05-30 10:44:40",
            "category_description": [
                {
                    "language_id": 2,
                    "name": "Sapato Social",
                    "description": "<p>Sapato Social<br></p>",
                    "meta_title": "",
                    "meta_description": "",
                    "meta_keyword": ""
                }
            ]
        }
    ]
}

/category/{{id}}

Método responsável por retornar os dados de uma categoria específico com todas suas informações.

Deverá ser realizado uma requisição GET informando o ID da categoria.

GET https://api.irroba.com.br/v1/category/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todas as categorias retornadas	Objeto em JSON
data category_id	ID da Categoria	Numérico (int)
data name	Nome da Categoria	String
data image	URL da imagem da categoria	String
data meta_title	Meta Título da categoria	String
data meta_description	Meta Descrição da categoria	String
data description	Descrição da categoria	String
data date_added	Data que a categoria foi adicionado (Padrão ISO 8601)	String
data status	Status da categoria no sistema	String
data sort_order	Ordenação com relação a outras categorias (do menor para o maior)	String

{
    "success": "true",
    "data": [
        {
            "category_id": 10159,
            "image": "",
            "parent_id": 0,
            "sort_order": 0,
            "status": 1,
            "date_added": "2018-11-14 08:20:22",
            "name": "Teste categoria",
            "description": "",
            "meta_title": "",
            "meta_description": "",
            "meta_keyword": ""
        }
    ]
}

/category/reference/{{reference}}

Método responsável por retornar os dados de uma categoria específico com todas suas informações.

Deverá ser realizado uma requisição GET informando a Reference da categoria.

GET https://api.irroba.com.br/v1/category/reference/{{reference}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todas as categorias retornadas	Objeto em JSON
data category_id	ID da Categoria	Numérico (int)
data reference	Referencia da Categoria	String
data name	Nome da Categoria	String
data image	URL da imagem da categoria	String
data meta_title	Meta Título da categoria	String
data meta_description	Meta Descrição da categoria	String
data description	Descrição da categoria	String
data date_added	Data que a categoria foi adicionado (Padrão ISO 8601)	String
data status	Status da categoria no sistema	String
data sort_order	Ordenação com relação a outras categorias (do menor para o maior)	String

{
    "success": "true",
    "data": [
        {
            "category_id": 10159,
            "reference": "4457",
            "image": "",
            "parent_id": 0,
            "sort_order": 0,
            "status": 1,
            "date_added": "2018-11-14 08:20:22",
            "name": "Teste categoria",
            "description": "",
            "meta_title": "",
            "meta_description": "",
            "meta_keyword": ""
        }
    ]
}

/category

Método responsável por adicionar uma categoria.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/category

Requisição

Nome	Descrição	Formato
reference	Referência da Categoria (id da categoria em seu ERP)	String / Máximo de 50 caracteres
name	Nome da Categoria	String / Obrigatório / Máximo de 64 caracteres
meta_title	Meta Título da categoria	String / Máximo de 255 caracteres
meta_description	Meta Descrição da categoria	String / Máximo de 300 caracteres
description	Descrição da categoria	String
status	Status da categoria (1 Habilitado 0 Desabilitado)	Int
sort_order	Ordenação com relação a outras categorias (do menor para o maior)	String / Máximo de 255 caracteres
path_reference	Reference da categoria Pai (principal), enviar somente um dos campos (path_reference ou path_id) / (Caso a categoria seja PAI não enviar o campo)	String
path_id	ID da categoria Pai (principal), enviar somente um dos campos (path_reference ou path_id) / (Caso a categoria seja PAI não enviar o campo)	Numérico (int)

{
    "reference": "124740",
    "name": "Nome da categoria teste",
    "sort_order": 3,
    "status": 1,
    "meta_title": "teste meta title category",
    "meta_description": "teste meta description category",
    "description": "informações sobre a categoria",
    "path_id": "1274"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Category inserted successfully!",
        "Category_id": 10172
    }
}

Customers (Clientes)

Tabela de possíveis ordenações

A baixo todos os filtros disponíveis para métodos que são listas de clientes. Para utilizar basta através da URL informar o parâmetro sort. E através do parâmetro order informar o tipo de ordenação (ASC ou DESC). Caso os valores informados estejam incorretos, por padrão os valores são date_added e DESC respectivamente.

Nome	Descrição
customer_id	ID do Cliente
type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)
firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)
lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia
email	Email do cliente comprador
birthday	Data de nascimento
sex	Sexo (M) Masculino ou (F) Feminino
telephone	Telefone do cliente, pode haver ou não formatação
cellphone	Celular do cliente, pode haver ou não formatação
mobile_operator	Operadora celular do cliente, pode haver ou não formatação
cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação
rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação
newsletter	Indica se o cliente aceita Newsletter
address_id	ID do endereço padrão do cliente
status	Status do cliente no sistema
approved	Indicador da aprovação do cliente
date_added	Data que o cliente foi adicionado (Padrão ISO 8601)
date_modified	Data que o cliente foi modificado (Padrão ISO 8601)

Tabela de Estados (Zone)

ID	Nome
440	Acre
441	Alagoas
442	Amapa
443	Amazonas
444	Bahia
445	Ceara
446	Distrito Federal
447	Espirito Santo
448	Goias
449	Maranhão
450	Mato Grosso
451	Mato Grosso do Sul
452	Minas Gerais
453	Para
454	Paraíba
455	Parana
456	Pernambuco
457	Piauí
458	Rio de Janeiro
459	Rio Grande do Norte
460	Rio Grande do Sul
461	Rondônia
462	Roraima
463	Santa Catarina
464	São Paulo
465	Sergipe
466	Tocantins

/customer

Método responsável por retornar uma lista com informações dos clientes. Além de retornar algumas informações do cliente, retornará também todos seus endereços cadastrados.

Há a possibilidade de ordenar os dados de acordo com a tabela.

Também é possível filtrar por clientes cadastrados ou atualizados a partir de uma data e horário específico, informando o parâmetro from_date com a data no padrão Y-m-d\TH:i:s (2021-12-31T12:00:00).

GET https://api.irroba.com.br/v1/customer

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
pagination total	Quantidade total de registros de clientes	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data customer_id	ID do Cliente	Numérico (int)
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data email	Email do cliente comprador	String
data birthday	Data de nascimento	String
data sex	Sexo (M) Masculino ou (F) Feminino	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data cellphone	Operadora celular do cliente, pode haver ou não formatação	String
data mobile_operator	Operadora celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data newsletter	Indica se o cliente aceita Newsletter	Numérico (int)
data address_id	ID do endereço padrão do cliente	Numérico (int)
data status	Status do cliente no sistema	Numérico (int)
data approved	Indicador da aprovação do cliente	Numérico (int)
data date_added	Data que o cliente foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o cliente foi modificado (Padrão ISO 8601)	String
data customer_group customer_group_id	ID do grupo de usuários do cliente	Numérico (int)
data customer_group name	Nome do grupo de usuários	Numérico (int)
data address firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data address lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data address address_1	Endereço do cliente	String
data address address_2	Complemento	String
data address number_home	Número	String
data address neighborhood	Bairro	String
data address city	Cidade	String
data address postcode	CEP, pode haver ou não formatação	String
data address country_id	ID do país, usar 30 para o Brasil	Numérico (int)
data address zone_id	ID do estado, conferir tabela de estados	Numérico (int)

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/customer?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2,
    "total": 2,
  },
  "data": [
      {
        "customer_id": 1,
        "type_person": "M",
        "firstname": "John Doe",
        "lastname": "",
        "cnpj_contact": "",
        "email": "john@irroba.com.br",
        "birthday": "1988-12-12",
        "sex": "M",
        "telephone": "",
        "cellphone": "(16) 9999-99999",
        "mobile_operator": "",
        "cpf_cnpj": "999.999.999-99",
        "rg_ie": "",
        "newsletter": 1,
        "address_id": 2181,
        "status": 1,
        "approved": 1,
        "date_added": "2016-09-14 14:14:16",
        "date_modified": "2017-04-11 17:42:52",
        "customer_group": {
          "customer_group_id": 8,
          "name": "Default"
        },
        "address": [
          {
            "address_id": 2181,
            "firstname": "John Doe",
            "lastname": "",
            "address_1": "Rua  Nabi Haber",
            "address_2": "",
            "number_home": "465",
            "neighborhood": "São José",
            "city": "Franca",
            "postcode": "14401-286",
            "country_id": 30,
            "zone_id": 464
          },
          {
            "address_id": 2056,
            "firstname": "Jane Doe",
            "lastname": "",
            "address_1": "Rua General Telles",
            "address_2": "",
            "number_home": "1234",
            "neighborhood": "Centro",
            "city": "Franca",
            "postcode": "14400-450",
            "country_id": 30,
            "zone_id": 464
          }
        ]
      },
      {
        "customer_id": 2,
        "type_person": "F",
        "firstname": "Jane Doe",
        "lastname": "",
        "cnpj_contact": "",
        "email": "jane@irroba.com.br",
        "birthday": "1988-12-12",
        "sex": "M",
        "telephone": "",
        "cellphone": "(16) 9999-99999",
        "mobile_operator": "",
        "cpf_cnpj": "999.999.999-99",
        "rg_ie": "",
        "newsletter": 1,
        "address_id": 2181,
        "status": 1,
        "approved": 1,
        "date_added": "2016-09-14 14:14:16",
        "date_modified": "2017-04-11 17:42:52",
        "customer_group": {
          "customer_group_id": 8,
          "name": "Default"
        },
        "address": [
          {
            "address_id": 2181,
            "firstname": "Jane Doe",
            "lastname": "",
            "address_1": "Rua  Nabi Haber",
            "address_2": "",
            "number_home": "465",
            "neighborhood": "São José",
            "city": "Franca",
            "postcode": "14401-286",
            "country_id": 30,
            "zone_id": 464
          },
          {
            "address_id": 2056,
            "firstname": "Jane Doe",
            "lastname": "",
            "address_1": "Rua General Telles",
            "address_2": "",
            "number_home": "1234",
            "neighborhood": "Centro",
            "city": "Franca",
            "postcode": "14400-450",
            "country_id": 30,
            "zone_id": 464
          }
        ]
      }
    ]
}

/customer/{{id}}

Método responsável por retornar os dados de um cliente específico com todas suas informações.

Deverá ser realizado uma requisição GET informando o ID do cliente.

GET https://api.irroba.com.br/v1/customer/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os pedidos retornados	Objeto em JSON
data customer_id	ID do Cliente	Numérico (int)
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data email	Email do cliente comprador	String
data birthday	Data de nascimento	String
data sex	Sexo (M) Masculino ou (F) Feminino	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data mobile_operator	Operadora celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data newsletter	Indica se o cliente aceita Newsletter	Numérico (int)
data address_id	ID do endereço padrão do cliente	Numérico (int)
data status	Status do cliente no sistema	Numérico (int)
data approved	Indicador da aprovação do cliente	Numérico (int)
data date_added	Data que o cliente foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o cliente foi modificado (Padrão ISO 8601)	String
data customer_group customer_group_id	ID do grupo de usuários do cliente	Numérico (int)
data customer_group name	Nome do grupo de usuários	Numérico (int)
data address firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data address lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data address address_1	Endereço do cliente	String
data address address_2	Complemento	String
data address number_home	Número	String
data address neighborhood	Bairro	String
data address city	Cidade	String
data address postcode	CEP, pode haver ou não formatação	String
data address country_id	ID do país, usar 30 para o Brasil	Numérico (int)
data address zone_id	ID do estado, conferir tabela de estados	Numérico (int)

{
  "success": "true",
  "data": {
    "customer_id": 1,
    "type_person": "F",
    "firstname": "John Doe",
    "lastname": "",
    "cnpj_contact": "",
    "email": "john@irroba.com.br",
    "birthday": "1988-12-12",
    "sex": "M",
    "telephone": "",
    "cellphone": "(16) 9999-99999",
    "mobile_operator": "",
    "cpf_cnpj": "999.999.999-99",
    "rg_ie": "",
    "newsletter": 1,
    "address_id": 2181,
    "status": 1,
    "approved": 1,
    "date_added": "2016-09-14 14:14:16",
    "date_modified": "2017-04-11 17:42:52",
    "customer_group": {
      "customer_group_id": 8,
      "name": "Default"
    },
    "address": [
      {
        "address_id": 2181,
        "firstname": "John Doe",
        "lastname": "",
        "address_1": "Rua  Nabi Haber",
        "address_2": "",
        "number_home": "465",
        "neighborhood": "São José",
        "city": "Franca",
        "postcode": "14401-286",
        "country_id": 30,
        "zone_id": 464
      },
      {
        "address_id": 2056,
        "firstname": "Jane Doe",
        "lastname": "",
        "address_1": "Rua General Telles",
        "address_2": "",
        "number_home": "1234",
        "neighborhood": "Centro",
        "city": "Franca",
        "postcode": "14400-450",
        "country_id": 30,
        "zone_id": 464
      }
    ]
  }
}

/customer/address_list/{{id}}

Método responsável por retornar os dados de endereços de um cliente específico.

Deverá ser realizado uma requisição GET informando o ID do cliente.

GET https://api.irroba.com.br/v1/customer/address_list/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os pedidos retornados	Objeto em JSON
data address_id	ID do Endereço	Numérico (int)
data customer_id	ID do Cliente	Numérico (int)
data firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data address_1	Endereço do cliente	String
data address_2	Complemento	String
data number_home	Número	String
data neighborhood	Bairro	String
data city	Cidade	String
data postcode	CEP, pode haver ou não formatação	String
data zone_id	ID do estado, conferir tabela de estados	Numérico (int)

{
    "success": true,
    "data": [
        {
            "address_id": 39,
            "customer_id": 33,
            "firstname": "Teste API",
            "lastname": "",
            "address_1": "Rua Nabi Haber",
            "address_2": "",
            "number_home": "465",
            "neighborhood": "São José",
            "city": "Franca",
            "postcode": "14401220",
            "zone_id": 464
        },
        {
            "address_id": 41,
            "customer_id": 33,
            "firstname": "Teste API",
            "lastname": "",
            "address_1": "Rua José Francisco Gomes Moreira",
            "address_2": "",
            "number_home": "465",
            "neighborhood": "Jardim Eulália",
            "city": "Taubaté",
            "postcode": "12010550",
            "zone_id": 464
        },
    ]
}

/customer/cpf_cnpj/{{cpf_cnpj}}

Método responsável por retornar os dados de um cliente específico com todas suas informações.

Deverá ser realizado uma requisição GET informando o CPF ou CNPJ do cliente.

GET https://api.irroba.com.br/v1/customer/cpf_cnpj/{{cpf_cnpj}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os pedidos retornados	Objeto em JSON
data customer_id	ID do Cliente	Numérico (int)
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data email	Email do cliente comprador	String
data birthday	Data de nascimento	String
data sex	Sexo (M) Masculino ou (F) Feminino	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data mobile_operator	Operadora celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data newsletter	Indica se o cliente aceita Newsletter	Numérico (int)
data address_id	ID do endereço padrão do cliente	Numérico (int)
data status	Status do cliente no sistema	Numérico (int)
data approved	Indicador da aprovação do cliente	Numérico (int)
data date_added	Data que o cliente foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o cliente foi modificado (Padrão ISO 8601)	String
data customer_group customer_group_id	ID do grupo de usuários do cliente	Numérico (int)
data customer_group name	Nome do grupo de usuários	Numérico (int)
data address firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data address lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data address address_1	Endereço do cliente	String
data address address_2	Complemento	String
data address number_home	Número	String
data address neighborhood	Bairro	String
data address city	Cidade	String
data address postcode	CEP, pode haver ou não formatação	String
data address country_id	ID do país, usar 30 para o Brasil	Numérico (int)
data address zone_id	ID do estado, conferir tabela de estados	Numérico (int)

{
  "success": "true",
  "data": {
    "customer_id": 1,
    "type_person": "F",
    "firstname": "John Doe",
    "lastname": "",
    "cnpj_contact": "",
    "email": "john@irroba.com.br",
    "birthday": "1988-12-12",
    "sex": "M",
    "telephone": "",
    "cellphone": "(16) 9999-99999",
    "mobile_operator": "",
    "cpf_cnpj": "999.999.999-99",
    "rg_ie": "",
    "newsletter": 1,
    "address_id": 2181,
    "status": 1,
    "approved": 1,
    "date_added": "2016-09-14 14:14:16",
    "date_modified": "2017-04-11 17:42:52",
    "customer_group": {
      "customer_group_id": 8,
      "name": "Default"
    },
    "address": [
      {
        "address_id": 2181,
        "firstname": "John Doe",
        "lastname": "",
        "address_1": "Rua  Nabi Haber",
        "address_2": "",
        "number_home": "465",
        "neighborhood": "São José",
        "city": "Franca",
        "postcode": "14401-286",
        "country_id": 30,
        "zone_id": 464
      },
      {
        "address_id": 2056,
        "firstname": "Jane Doe",
        "lastname": "",
        "address_1": "Rua General Telles",
        "address_2": "",
        "number_home": "1234",
        "neighborhood": "Centro",
        "city": "Franca",
        "postcode": "14400-450",
        "country_id": 30,
        "zone_id": 464
      }
    ]
  }
}

/customer/abandoned_cart

Método responsável por retornar uma lista com informações dos carrinhos abandonados dos clientes.

GET https://api.irroba.com.br/v1/customer/abandoned_cart

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data customer_cart_id	ID do Carrinho Abandonado	Numérico (int)
data firstname	Primeiro nome do cliente	String
data lastname	Último nome do cliente	String
data email	E-mail do cliente	String
data product_info	Objeto com informações do produto	Objeto em Json
data product_info product_id	ID do produto	Numérico (int)
data product_info model	Código do produto	String
data product_info name	Nome do produto	String
data product_info image	Imagem do produto	String
data product_info option	Objeto com informações da opção de estoque	Objeto em Json
data product_info option name	Nome da opção de estoque	String
data product_info option value	Valor da opção de estoque	String
data product_info option quantity	Quantidade da opção de estoque	Numérico (int)

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/customer/abandoned_cart?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
    {
	  "customer_cart_id": 4,
	  "firstname": "Teste Irroba",
	  "lastname": "",
	  "email": "mairo.oliveira@irroba.com.br",
	  "product_info": [
		{
		  "product_id": 3010,
          "model": "produto_teste",
          "name": "Produto Teste",
          "image": "placeholder.png",
          "option": [
			{
			  "name": "Tamanho",
			  "value": "33",
			  "quantity": 1
			}
		  ]
		}
      ]
	}
  ]
}

/customer/abandoned_cart/{{id}}

Método responsável por retornar os dados de um carrinho abandonado específico com todas suas informações.

GET https://api.irroba.com.br/v1/customer/abandoned_cart{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os clientes retornados	Objeto em JSON
data customer_cart_id	ID do Carrinho Abandonado	Numérico (int)
data firstname	Primeiro nome do cliente	String
data lastname	Último nome do cliente	String
data email	E-mail do cliente	String
data product_info	Objeto com informações do produto	Objeto em Json
data product_info product_id	ID do produto	Numérico (int)
data product_info model	Código do produto	String
data product_info name	Nome do produto	String
data product_info image	Imagem do produto	String
data product_info option	Objeto com informações da opção de estoque	Objeto em Json
data product_info option name	Nome da opção de estoque	String
data product_info option value	Valor da opção de estoque	String
data product_info option quantity	Quantidade da opção de estoque	Numérico (int)

{
  "success": "true",
  "data": [
    {
	  "customer_cart_id": 4,
	  "firstname": "Teste Irroba",
	  "lastname": "",
	  "email": "mairo.oliveira@irroba.com.br",
	  "product_info": [
		{
		  "product_id": 3010,
          "model": "produto_teste",
          "name": "Produto Teste",
          "image": "placeholder.png",
          "option": [
			{
			  "name": "Tamanho",
			  "value": "33",
			  "quantity": 1
			}
		  ]
		}
      ]
	}
  ]
}

/customer

Método responsável por adicionar um cliente.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/customer

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do cliente	Objeto em JSON
data customer_group_id	Indica a qual grupo o cliente pertence, conferir o método para consulta de customer_group	String
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String / Máximo de 1 caracter
data firstname	Primeiro Nome do Cliente	String / Obrigatório / Máximo de 128 caracteres
data lastname	Sobrenome Nome do Cliente	StringMáximo de 32 caracteres
data email	E-mail do cliente	String / Obrigatório / Máximo de 96 caracteres
data cpf_cnpj	CPF ou CNPJ do cliente	String / Obrigatório / Máximo de 40 caracteres
data rg_ie	RG ou Inscrição Estadual do cliente	String / Máximo de 40 caracteres
data birthday	Data de aniversário do cliente	String/ Obrigatório / Máximo de 40 caracteres
data sex	Sexo do cliente (M Masculino F Feminino)	String / Obrigatório / Máximo de 1 caracteres
data telephone	Telefone do cliente	String / Máximo de 32 caracteres
data cellphone	Celular do cliente	String / Obrigatório / Máximo de 32 caracteres
data status	Status do cliente (1 Habilitado, 0 Desabilitado)	String / Máximo de 1 caracteres
data approved	Aprovação de cadastro do cliente (1 Aprovado, 0 Pendente)	String / Máximo de 1 caracteres
data customer_attacked	Indica se o cliente está habilitado a comprar no atacado (1 Sim, 0 Não)	String / Máximo de 1 caracteres
data limit_credit	Inserir créditos para o cliente	Numérico (int)
data password	Senha do cliente	String / Mínimo de 6 caracteres
data address	Json com informação do endereço do cliente	JSON / Obrigatório
data address firstname	Nome do cliente	String / Obrigatório / Máximo de 128 caracteres
data address address_1	Rua do cliente	String / Obrigatório / Máximo de 128 caracteres
data address address_2	Complemento	String / Máximo de 128 caracteres
data address number_home	Numero da casa	String / Obrigatório / Máximo de 10 caracteres
data address neighborhood	Bairro	String / Obrigatório / Máximo de 128 caracteres
data address city	Cidade	String / Obrigatório / Máximo de 128 caracteres
data address postcode	CEP	String / Obrigatório / Máximo de 10 caracteres
data address zone_id	ID do estado, conferir tabela de estados	Numérico (int) / Obrigatório /

{
  "customer_group_id": "8",
  "type_person": "F",
  "firstname": "Teste API",
  "lastname": "Customer",
  "email": "api@irroba.com.br",
  "cpf_cnpj": "43919978***",
  "rg_ie": "467198932***",
  "birthday": "1995-09-04",
  "sex": "M",
  "telephone": "(16)30303030",
  "cellphone": "(16)993118372",
  "status": "1",
  "approved": "1",
  "customer_attacked": "0",
  "limit_credit": 10,
  "password": "1154abd5",
  "address": [
    {
      "firstname": "Teste API",
      "address_1": "Rua Nabi Haber",
      "number_home": "465",
      "neighborhood": "São José",
      "city": "Franca",
      "postcode": "14401220",
      "zone_id": "464"
    }
  ]
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Customer inserted successfully!",
        "Customer_id": 30
    }
}

/customer/login

Método responsável por realizar o "login" do usuário, pode ser utilizado em aplicativos ou validação do cliente por exemplo. Deverá ser realizado um POST informando o email e senha do mesmo, caso esteja correto irá retornar os dados do mesmo, caso contrário retornará success como "false".

POST https://api.irroba.com.br/v1/customer/login

Requisição

Nome	Descrição	Formato
email	Email do cliente	String
password	Senha do cliente	String

{
    "email": "john@irroba.com.br",
    "password": "123456"
}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os pedidos retornados	Objeto em JSON
data customer_id	ID do Cliente	Numérico (int)
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String
data lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia	String
data email	Email do cliente comprador	String
data birthday	Data de nascimento	String
data sex	Sexo (M) Masculino ou (F) Feminino	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data address_id	ID do endereço padrão do cliente	Numérico (int)

{
  "success": "true",
  "data": {
    "customer_id": 1,
    "type_person": "F",
    "firstname": "John Doe",
    "lastname": "",
    "cnpj_contact": "",
    "email": "john@irroba.com.br",
    "birthday": "1988-12-12",
    "sex": "M",
    "telephone": "",
    "cellphone": "(16) 99999-9999",
    "mobile_operator": "",
    "cpf_cnpj": "999.999.999-99",
    "rg_ie": "",
    "address_id": 2181
  }
}

/customer/{{id}}

Método responsável por editar um cliente.

Deverá ser realizado uma requisição PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/customer/{{id}}

Requisição

Nome	Descrição	Formato
customer_group_id	Indica a qual grupo o cliente pertence, conferir o método para consulta de customer_group	String
firstname	Primeiro Nome do Cliente	String / Máximo de 128 caracteres
lastname	Sobrenome Nome do Cliente	String / Máximo de 32 caracteres
birthday	Data de aniversário do cliente	String/ Máximo de 40 caracteres
telephone	Telefone do cliente	String / Máximo de 32 caracteres
cellphone	Celular do cliente	String / Máximo de 32 caracteres
status	Status do cliente (1 Habilitado, 0 Desabilitado)	String / Máximo de 1 caracteres
approved	Aprovação de cadastro do cliente (1 Aprovado, 0 Pendente)	String / Máximo de 1 caracteres
customer_attacked	Indica se o cliente está habilitado a comprar no atacado (1 Sim, 0 Não)	String / Máximo de 1 caracteres
limit_credit	Inserir créditos para o cliente	Numérico (int)

{
    "customer_group_id": "8",
    "firstname": "Teste API",
    "lastname": "Customer",
    "birthday": "1995-09-04",
    "telephone": "(16)30303030",
    "cellphone": "(16)993118372",
    "status": "1",
    "approved": "1",
    "customer_attacked": "0",
    "limit_credit": 10
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Customer updated successfully!",
        "Customer_id": 30
    }
}

/customer/group

Método responsável por retornar uma lista com informações dos grupos de clientes.

GET https://api.irroba.com.br/v1/customer/group

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os grupos de clientes retornadas	Objeto em JSON
data customer_group_id	ID do grupo de clientes	Numérico (int)
data sort_order	Ordenação dentro do e-commerce (do menor para o maior)	Numérico (int)
data buying_minimum_value	Valor mínimo para o cliente conseguir efetuar uma compra	String
data minimum_quantity_of_products	Quantidade mínima de produtos para o cliente conseguir efetuar uma compra	Numérico (int)
data minimum_quantity_per	Indica se a quantidade mínima é sobre os produtos ou itens ('P' para produtos, 'I' para itens)	String
data customer_group_description	Objeto com informações descritivas do grupo de clientes	Objeto em JSON
data customer_group_description name	Nome do grupo de clientes	String
data customer_group_description description	Descrição do grupo de clientes	String

{
"success": "true",
"pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": null,
    "firstItem": 1,
    "lastItem": 6
},
"data": [
    {
        "customer_group_id": 120,
        "sort_order": 0,
        "buying_minimum_value": "0.00",
        "minimum_quantity_of_products": 0
        "minimum_quantity_per": "",
        "customer_group_description": {
            "name": "Representante",
            "description": "Representante"
        }
    },
    {
        "customer_group_id": 111,
        "sort_order": 0,
        "buying_minimum_value": "0.00",
        "minimum_quantity_of_products": 0
        "minimum_quantity_per": "",
        "customer_group_description": {
            "name": "CNPJ MEI",
            "description": "CNPJ MEI"
        }
    },
    {
        "customer_group_id": 110,
        "sort_order": 0,
        "buying_minimum_value": "0.00",
        "minimum_quantity_of_products": 0
        "minimum_quantity_per": "",
        "customer_group_description": {
            "name": "Vendedor",
            "description": "Vendedor"
        }
    },
    {
        "customer_group_id": 100,
        "sort_order": 0,
        "buying_minimum_value": "0.00",
        "minimum_quantity_of_products": 0
        "minimum_quantity_per": "",
        "customer_group_description": {
            "name": "Transportadora",
            "description": "Transportadora"
        }
    },
    {
        "customer_group_id": 90,
        "sort_order": 0,
        "buying_minimum_value": "0.00",
        "minimum_quantity_of_products": 0
        "minimum_quantity_per": "",
        "customer_group_description": {
            "name": "Fornecedor",
            "description": "Fornecedor"
        }
    },
    {
        "customer_group_id": 8,
        "sort_order": 0,
        "buying_minimum_value": "0.00",
        "minimum_quantity_of_products": 0
        "minimum_quantity_per": "",
        "customer_group_description": {
            "name": "Default",
            "description": ""
        }
    }
]
}

/customer/group

Método responsável por adicionar um grupo de clientes.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/customer/group

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do grupo cliente	Objeto em JSON
data sort_order	Ordenação dentro do e-commerce (do menor para o maior)	Numérico (int) / Máximo de 1 caracter
data buying_minimum_value	Valor mínimo para o cliente conseguir efetuar uma compra	Numérico (float)
data minimum_quantity_of_products	Quantidade mínima de produtos para o cliente conseguir efetuar uma compra	Numérico (int) / Máximo de 2 caracter
data minimum_quantity_per	Indica se a quantidade mínima é sobre os produtos ou itens ('P' para produtos, 'I' para itens)	String
data customer_group_description name	Nome do grupo de clientes	String / Obrigatório / Máximo de 32 caracteres
data customer_group_description description	Descrição do grupo de clientes	String / Obrigatório / Máximo de 128 caracteres

{
    "sort_order": 0,
    "buying_minimum_value": 0.00,
    "minimum_quantity_of_products": 0,
    "minimum_quantity_per": "",
    "customer_group_description": {
        "name": "Grupo de Cliente",
        "description": "Grupo de Cliente"
    }
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Customer Group inserted successfully!",
        "customer_group_id": 30
    }
}

/customer/group/{{id}}

Método responsável por editar um grupo de cliente.

Deverá ser realizado uma requisição PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/customer/group/{{id}}

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do grupo de cliente	Objeto em JSON
data sort_order	Ordenação dentro do e-commerce (do menor para o maior)	Numérico (int) / Máximo de 1 carácter
data buying_minimum_value	Valor mínimo para o cliente conseguir efetuar uma compra	Numérico (float)
data minimum_quantity_of_products	Quantidade mínima de produtos para o cliente conseguir efetuar uma compra	Numérico (int) / Máximo de 2 carácter
data minimum_quantity_per	Indica se a quantidade mínima é sobre os produtos ou itens ('P' para produtos, 'I' para itens)	String
data customer_group_description name	Nome do grupo de clientes	String / Máximo de 32 caracteres
data customer_group_description description	Descrição do grupo de clientes	String / Máximo de 128 caracteres

{
    "sort_order": 0,
    "buying_minimum_value": 0.00,
    "minimum_quantity_of_products": 0,
    "minimum_quantity_per": "",
    "customer_group_description": {
        "name": "Grupo de Cliente",
        "description": "Grupo de Cliente"
    }
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Customer Group updated successfully!",
        "Customer_id": 30
    }
}

Addresses (Endereços)

/address

Método responsável por adicionar um endereço.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/address

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do cliente	Objeto em JSON
data customer_id	Informa o ID do cliente que será relacionado com o endereço cadastrado	Numérico (int) / Obrigatório /
data firstname	Primeiro Nome do Cliente	String / Obrigatório / Máximo de 128 caracteres
data lastname	Sobrenome Nome do Cliente	StringMáximo de 32 caracteres
data address_1	Rua do cliente	String / Obrigatório / Máximo de 128 caracteres
data address_2	Complemento	String / Máximo de 128 caracteres
data number_home	Número	String / Obrigatório / Máximo de 10 caracteres
data neighborhood	Bairro	String / Obrigatório / Máximo de 128 caracteres
data city	Cidade	String / Obrigatório / Máximo de 128 caracteres
data postcode	CEP	String / Obrigatório / Máximo de 10 caracteres
data zone_id	ID do estado, conferir tabela de estados	Numérico (int) / Obrigatório /

{
    "customer_id": 33,
    "firstname": "Teste API",
    "address_1": "Rua Romênia",
    "number_home": "465",
    "neighborhood": "Jardim Santa Cecília",
    "city": "Guarulhos",
    "postcode": "07123400",
    "zone_id": 464
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Address inserted successfully!"
}

/address/{{id}}

Método responsável por deletar um endereço DELETE com o request necessário e informando o ID do mesmo.

DELETE https://api.irroba.com.br/v1/address/{{id}}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Address deleted successfully!"
}

Manufacturers (Fabricantes)

Tabela de possíveis ordenações

Nome	Descrição
customer_id	ID do Cliente
type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)
firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)
lastname	Pessoa Física pode estar incluso no firstname / Pessoa Jurídica é o nome Fantasia
email	Email do cliente comprador
birthday	Data de nascimento
sex	Sexo (M) Masculino ou (F) Feminino
telephone	Telefone do cliente, pode haver ou não formatação
cellphone	Celular do cliente, pode haver ou não formatação
mobile_operator	Operadora celular do cliente, pode haver ou não formatação
cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação
rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação
newsletter	Indica se o cliente aceita Newsletter
address_id	ID do endereço padrão do cliente
status	Status do cliente no sistema
approved	Indicador da aprovação do cliente
date_added	Data que o cliente foi adicionado (Padrão ISO 8601)
date_modified	Data que o cliente foi modificado (Padrão ISO 8601)

/manufacturer

Método responsável por retornar uma lista com informações dos fabricantes.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/manufacturer

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data manufacturer_id	ID do Fabricante	Numérico (int)
data name	Nome do Fabricante	String
data image	URL da imagem do fabricante	String
data banner	Imagem (URL) do banner do fabricante	String
data meta_title	Meta Título do fabricante	String
data meta_description	Meta Descrição do fabricante	String
data description	Descrição do fabricante	String
data sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	String
data date_added	Data que o fabricante foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o fabricante foi adicionado (Padrão ISO 8601)	String
data user_log	Data que o fabricante foi adicionado (Padrão ISO 8601)	String

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
        "previousPageUrl": null,
        "nextPageUrl": null,
        "firstItem": 1,
        "lastItem": 2
    },
    "data": [
        {
            "manufacturer_id": 8,
            "name": "Adidas",
            "image": "",
            "banner": "",
            "meta_title": "",
            "meta_description": "",
            "description": "",
            "sort_order": 0,
            "date_added": "2016-04-28 10:31:37",
            "date_modified": "2017-05-03 13:57:47",
            "user_log": "lojista"
        },
        {
            "manufacturer_id": 9,
            "name": "Nike",
            "image": "www.irrobastore.com.br/image/catalog/icones/nike.jpg",
            "banner": "",
            "meta_title": "",
            "meta_description": "",
            "description": "",
            "sort_order": 1,
            "date_added": "2016-06-14 12:29:15",
            "date_modified": "2017-05-03 13:58:14",
            "user_log": "lojista"
        }
    ]
}

/manufacturer/{{id}}

Método responsável por retornar os dados de um fabricante específico com todas suas informações.

Deverá ser realizado uma requisição GET informando o ID do fabricante.

GET https://api.irroba.com.br/v1/manufacturer/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os clientes retornados	Objeto em JSON
data manufacturer_id	ID do Fabricante	Numérico (int)
data name	Nome do Fabricante	String
data image	URL da imagem do fabricante	String
data banner	Imagem (URL) do banner do fabricante	String
data meta_title	Meta Título do fabricante	String
data meta_description	Meta Descrição do fabricante	String
data description	Descrição do fabricante	String
data sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	String
data date_added	Data que o fabricante foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o fabricante foi adicionado (Padrão ISO 8601)	String
data user_log	Data que o fabricante foi adicionado (Padrão ISO 8601)	String

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
        "previousPageUrl": null,
        "nextPageUrl": null,
        "firstItem": 1,
        "lastItem": 2
    },
    "data": [
        {
            "manufacturer_id": 8,
            "name": "Adidas",
            "image": "",
            "banner": "",
            "meta_title": "",
            "meta_description": "",
            "description": "",
            "sort_order": 0,
            "date_added": "2016-04-28 10:31:37",
            "date_modified": "2017-05-03 13:57:47",
            "user_log": "lojista"
        },
        {
            "manufacturer_id": 9,
            "name": "Nike",
            "image": "www.irrobastore.com.br/image/catalog/icones/nike.jpg",
            "banner": "",
            "meta_title": "",
            "meta_description": "",
            "description": "",
            "sort_order": 1,
            "date_added": "2016-06-14 12:29:15",
            "date_modified": "2017-05-03 13:58:14",
            "user_log": "lojista"
        }
    ]
}

/manufacturer

Método responsável por adicionar um fabricante.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/manufacturer

Requisição

Nome	Descrição	Formato
name	Nome do Fabricante	String / Obrigatório / Máximo de 64 caracteres
meta_title	Meta Título do fabricante	String / Máximo de 255 caracteres
meta_description	Meta Descrição do fabricante	String / Máximo de 300 caracteres
description	Descrição do fabricante	String
sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	String / Máximo de 255 caracteres

{
    "name": "Teste",
    "banner": "",
    "meta_title": "",
    "meta_description": "",
    "description": "",
    "sort_order": 0
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Manufacturer inserted successfully!",
        "manufacturer_id": 10172
    }

}

/manufacturer/{{id}}

Método responsável por editar um fabricante.

Deverá ser realizado uma requisição PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/manufacturer/{{id}}

Requisição

Nome	Descrição	Formato
name	Nome do Fabricante	String / Obrigatório / Máximo de 64 caracteres
meta_title	Meta Título do fabricante	String / Máximo de 255 caracteres
meta_description	Meta Descrição do fabricante	String / Máximo de 300 caracteres
description	Descrição do fabricante	String
sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	String / Máximo de 255 caracteres

{
    "name": "Teste",
    "banner": "",
    "meta_title": "",
    "meta_description": "",
    "description": "",
    "sort_order": 0
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Manufacturer updated successfully!"
}

/manufacturer/{{id}}

Método responsável por deletar um fabricante.

Deverá ser realizado uma requisição DELETE informando o ID do mesmo.

DELETE https://api.irroba.com.br/v1/manufacturer/{{id}}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Manufacturer deleted successfully!"
}

Coupons (Cupons)

Tabela de possíveis ordenações

A baixo todos os filtros disponíveis para métodos que são listas de cupons. Para utilizar basta através da URL informar o parâmetro sort. E através do parâmetro order informar o tipo de ordenação (ASC ou DESC). Caso os valores informados estejam incorretos, por padrão os valores são date_added e DESC respectivamente.

Nome	Descrição
coupon_id	ID do Cupom
name	Nome do cupom
code	Código do cupom
type	Tipo de desconto, (P - Porcentagem / F - Valor Fixo )
product_id	ID do produto
discount	Valor do desconto
free_shipping_methods	Métodos de envio
logged	Retorna true ou false se está logado
total	O Valor total do pedido deve ser alcançado antes que o cupom seja validado
discount_disabled	Desativar desconto à vista quando esse cupom for escolhido
date_start	Início da validade do cupom
date_end	Fim da validade do cupom
uses_total	Quantidade total de uso por cupom
uses_customer	Retorna true ou false se o cliente faz utilização
status	Status do cupom
user_log	Nome do usuário logado
coupon_product	Objeto do produto do cupom
coupon_category	Objeto da categoria do cupom
coupon_manufacturer	Objeto do fabricante do cupom

/coupon

Método responsável por retornar uma lista com informações dos cupons.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/coupon

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data coupon_id	ID do cupom	Numérico (int)
data name	Nome do cupom	String
data code	Código do cupom	String
data type	Tipo de desconto, (P - Porcentagem / F - Valor Fixo )	String
data product_id	ID do produto	Numérico(int)
data discount	Valor para o desconto	String
data free_shipping	Oferecer frete grátis (1 = Oferecer / 0 = Não oferecer)	String
data logged	Cupom visível para usuário logado (1 = Visível / 0 = Invisível)	Numérico(int)
data total	O Valor total do pedido deve ser alcançado antes que o cupom seja validado	String
data discount_disabled	Desativar desconto à vista quando esse cupom for escolhido	Numérico(int)
data date_start	Data de início do cupom	String
data date_end	Data de fim do cupom	String
data uses_total	Quantidade total de uso por cupom	Numérico(int)
data uses_customer	Numero de vezes que o cupom pode ser utilizado por um único cliente	String
data status	Status do cupom, 1 para habilitado, 0 para desabilitado	Numérico(int)
data user_log	Usuário logado	String
data coupon_product	Objeto com todos os produtos retornados relacionados a este cupom	Objeto em JSON
data coupon_product product_id	ID do produto relacionado ao cupom	Numérico (int)
data coupon_category category_id	ID da categoria relacionada ao cupom	Numérico (int)
data coupon_manufacturer manufacturer_id	ID do manufacturer relacionado ao cupom	Numérico (int)

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
		"previousPageUrl": null,
		"nextPageUrl": null,
		"firstItem": 1,
		"lastItem": 25
    },
    "data": [
        {
            "coupon_id": 134,
            "name": "Primeira Compra",
            "code": "DAY10",
            "type": "F",
            "product_id": 0,
            "discount": "10.0000",
            "free_shipping_methods": "",
            "logged": 1,
            "total": "99.9000",
            "discount_disabled": 1,
            "date_start": "2021-07-20",
            "date_end": "2021-08-15",
            "uses_total": 0,
            "uses_customer": "1",
            "status": 1,
            "user_log": "lojista",
            "coupon_product": [],
            "coupon_category": [],
            "coupon_manufacturer": [],
        },
        {
            "coupon_id": 135,
            "name": "Recompra - Carta",
            "code": "DAYVINDOS22",
            "type": "P",
            "product_id": 0,
            "discount": "22.0000",
            "free_shipping_methods": "",
            "logged": 0,
            "total": "150.0000",
            "discount_disabled": 0,
            "date_start": "2022-01-20",
            "date_end": "2021-12-15",
            "uses_total": 0,
            "uses_customer": "1",
            "status": 1,
            "user_log": "lojista",
            "coupon_product": [],
            "coupon_category": [],
            "coupon_manufacturer": [],
        }
    ]
}

/coupon/{{code}}

Método responsável por retornar os dados de um cupom específico com todas suas informações.

Deverá ser realizado uma requisição GET informando o CÓDIGO do cupom.

GET https://api.irroba.com.br/v1/coupon/{{code}}

Requisição

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os dados do cupom retornados	Objeto em JSON
data coupon_id	ID do cupom	Numérico (int)
data name	Nome do cupom	String
data code	Código do Cupom	String
data type	Tipo de desconto, (P - Porcentagem / F - Valor Fixo )	String
data product_id	ID do produto relacionado ao cupom	Numérico(int)
data discount	Valor para o desconto	String
data free_shipping_methods	Oferecer frete grátis (1 = Oferecer / 0 = Não oferecer)	String
data logged	Cupom visível para usuário logado (1 = Visível / 0 = Invisível)	Numérico(int)
data total	O Valor total do pedido deve ser alcançado antes que o cupom seja validado	String
data discount_disabled	Desativar desconto à vista quando esse cupom for escolhido	Numérico(int)
data date_start	Data de início do cupom	String
data date_end	Data de fim do cupom	String
data uses_total	Quantidade total de uso por cupom	Numérico(int)
data uses_customer	Numero de vezes que o cupom pode ser utilizado por um único cliente	String
data status	Status do cupom, 1 para habilitado, 0 para desabilitado	Numérico(int)
data user_log	Usuário logado	String
data coupon_product	Objeto com todos os produtos retornados relacionados a este cupom	Objeto em JSON
data coupon_product product_id	ID do produto relacionado ao cupom	Numérico (int)
data coupon_category category_id	ID da categoria relacionada ao cupom	Numérico (int)
data coupon_manufacturer manufacturer_id	ID do manufacturer relacionado ao cupom	Numérico (int)

{
    "success": "true",
    "data": [
        {
            "coupon_id": 134,
            "name": "Primeira Compra",
            "code": "DAY10",
            "type": "F",
            "product_id": 0,
            "discount": "10.0000",
            "free_shipping_methods": "",
            "logged": 1,
            "total": "99.9000",
            "discount_disabled": 1,
            "date_start": "2021-07-20",
            "date_end": "2021-08-15",
            "uses_total": 0,
            "uses_customer": "1",
            "status": 1,
            "user_log": "lojista",
            "coupon_product": [],
            "coupon_category": [],
            "coupon_manufacturer": [],
        },
    ]
}

Marketing

/coupon

Método responsável por adicionar um cupom de desconto.

Você pode utilizar a tabela de métodos de envio para conhecer os possíveis "Métodos de Envio".

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/coupon

Requisição

Nome	Descrição	Formato
name	Nome do cupom de desconto	String / Obrigatório / Máximo de 100 caracteres
code	Código do cupom de desconto	String / Obrigatório / Máximo de 40 caracteres
type	Tipo de desconto, (P - Porcentagem / F - Valor Fixo )	String
discount	Valor para o desconto	Numérico (float) / Obrigatório
total	O Valor total do pedido deve ser alcançado antes que o cupom seja validado	Numérico (float)
discount_disabled	Desativar desconto à vista quando esse cupom for escolhido	Numérico (int)
uses_special_price	Habilitar cupom apenas para produtos que não estão em promoção (1 = Habilitado / 0 = Desabilitado)	Numérico(int)
free_shipping	Oferecer frete grátis (1 = Oferecer / 0 = Não oferecer)	Numérico (int)
free_shipping_methods	Métodos de envio que receberão o frete grátis	Objeto em JSON
date_start	Data de início do cupom	String / Obrigatório
date_end	Data final do cupom	String / Obrigatório
uses_total	Quantidade total de uso por cupom	Numérico (int) / Obrigatório
uses_customer	Numero de vezes que o cupom pode ser utilizado por um único cliente	Numérico (int) / Obrigatório
status	Status do cupom, 1 para habilitado, 0 para desabilitado	Numérico (int) / Obrigatório

{
    "name": "Cupom de Teste",
    "code": "testeapi123",
    "discount": 10,
    "type": "P",
    "total": 100.00,
    "free_shipping": 1,
    "free_shipping_methods": [
        "gollog",
        "jadlog_api",
        "kangu"
    ],
    "discount_disabled": 0,
    "date_start": "2019-09-12",
    "date_end": "2019-09-20",
    "uses_total": 100,
    "uses_customer": 5,
    "status": 1
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
        "success": "true",
        "data": {
            "Message": "Coupon inserted successfully!",
            "coupon_id": 5
        }
    }

Options (Opções)

Tabela de possíveis ordenações

A baixo todos os filtros disponíveis para métodos que são opções de estoque. Para utilizar basta através da URL informar o parâmetro sort. E através do parâmetro order informar o tipo de ordenação (ASC ou DESC). Caso os valores informados estejam incorretos, por padrão os valores são option_id e DESC respectivamente.

Nome	Descrição
option_id	ID da Opção
sort_order	Ordenação das opções
status	Status da opção, 1 para habilitado, 0 para desabilitado
date_modified	Data que o produto foi modificado (Padrão ISO 8601)
user_log	Usuário que realizou a última alteração

Tabela de tipos de opções

Nome	Descrição
select	Escolha
select_list	Escolha (Em Lista)
grid	Grade
radio	Radio
checkbox	checkbox
text	Texto
textarea	Área de texto
datetime	Data & Hora

/option

Método responsável por retornar uma lista com informações das opções de estoque.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/option

Resposta

type	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos as opções retornadas	Objeto em JSON
data option_id	ID da Opção	Numérico (int)
data type	Tipo da opção	String
data sort_order	Ordenação dentro do e-commerce (do menor para o maior)	Numérico (int)
data name	Nome da opção	String
data status	Status da opção (1 = Habilitado / 0 = Desabilitado)	Numérico (int)
data option_info option_value_id	ID da Variação	Numérico (int)
data option_info option_id	ID da opção	Numérico (int)
data option_info sort_order	Ordenação dentro do e-commerce (do menor para o maior)	Numérico (int)
data option_info name	Nome da Variação	String
data option_info allow_delete	Informa se a variação pode ser removida via API (1 = Sim / 0 = Não)	Numérico (int)

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/option?page=1&limit=2&sort=option_id&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
        {
            "option_id": 49,
            "type": "select",
            "sort_order": 1,
            "name": "Pequeno/Médio/Grande",
            "status": "1",
            "option_info": [
                {
                    "option_value_id": 17384,
                    "option_id": 49,
                    "sort_order": 1,
                    "name": "Pequeno",
                    "allow_delete": 0
                },
                {
                    "option_value_id": 17387,
                    "option_id": 49,
                    "sort_order": 2,
                    "name": "Medio",
                    "allow_delete": 1
                },
                {
                    "option_value_id": 17385,
                    "option_id": 49,
                    "sort_order": 3,
                    "name": "Grande",
                    "allow_delete": 0
                }
            ]
        },
        {
            "option_id": 34,
            "type": "select",
            "sort_order": 1,
            "name": "Cores Disponíveis",
            "status": "1",
            "option_info": [
                {
                    "option_value_id": 290,
                    "option_id": 34,
                    "sort_order": 1,
                    "name": "Preto",
                    "allow_delete": 1
                },
                {
                    "option_value_id": 324,
                    "option_id": 34,
                    "sort_order": 35,
                    "name": "Branco",
                    "allow_delete": 1
                },
                {
                    "option_value_id": 325,
                    "option_id": 34,
                    "sort_order": 36,
                    "name": "Verde claro",
                    "allow_delete": 1
                }
            ]
        }
    ]
}

/option

Método responsável por adicionar uma opção.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/option

Requisição

Nome	Descrição	Formato
type	Tipo da opção de estoque, conforme a tabela de tipo de opções	String / Obrigatório / Máximo de 20 caracteres
status	Estado atual da opção (Ativado = 1 / Desativado = 0)	Numérico (int) / Obrigatório / Máximo de 64 caracteres
sort_order	Ordenação com relação a outras opções (do menor para o maior)	Numérico (int)
name	Nome da opção de estoque	String / Obrigatório / Máximo de 300 caracteres
data option_value	Json com informações das variações da opção de estoque	JSON
data option_value sort_order	Ordenação com relação a outras variações (do menor para o maior)	Numérico (int)
data option_value name	Nome da variação	String

{
    "type": "select",
    "status": 1,
    "sort_order": 0,
    "name": "opcao teste",
    "option_value": [
        {
            "sort_order": 1,
            "name": "33"
        },
        {
            "sort_order": 2,
            "name": "34"
        }
    ]
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "option inserted successfully!",
        "option_id": 54,
        "options_values": [
            {
                "name": "33",
                "option_value_id": 17418
            },
            {
                "name": "34",
                "option_value_id": 17419
            }
        ]
    }
}

/option/variation/{{id}}

Método responsável por adicionar uma nova variação para opção de estoque PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/option/variation/{{id}}

Requisição

Nome	Descrição	Formato
name	Nome da nova variação	String / Obrigatório
sort_order	Ordenação com relação a outras opções (do menor para o maior)	Numérico (int)
order_by	Refaz a ordenação de todas variações desta opção de estoque de acordo com o nome das variações (Deve ser enviado somente ASC ou DESC)	String
link_products	A variação adicionada, será inserida em todos produtos que possuem essa opção de estoque (True ou False)	bool
subtract	Define se a variação inserida nos produtos ira controlar estoque ou não (1 = Controla estoque, 0 = Não controla estoque)	Numérico (int)

{
    "name": "39",
    "sort_order": 3,
    "link_products": false,
    "subtract": 0,
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "variation inserted successfully!",
        "option_value_id": 17417
    }
}

/option/variation/{{id}}

Método responsável por deletar uma variação para opção de estoque DELETE com o request necessário e informando o ID do mesmo.

Observação: Toda vez que utilizar este método a variação sera removida de todos os produtos que estiver vinculada, somente é permitido deletar variações criadas a partir da API, demais variações criadas no painel administrativo o lojista deve entrar em contato com o suporte solicitando a remoção.

DELETE https://api.irroba.com.br/v1/option/variation/{{id}}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "variation deleted successfully!"
    }
}

Products (Produtos)

Nome	Descrição
product_id	ID do Produto
model	Código do produto
image	Imagem do produto (Path interno)
price	Preço do produto
cost_price	Preço de custo do produto
weight	Peso
length	Comprimento
width	Largura
height	Altura
SKU	Muitas vezes utilizado como EAN / Código de barras
status	Status do produto, 1 para habilitado, 0 para desabilitado
date_added	Data que o produto foi adicionado (Padrão ISO 8601)
date_modified	Data que o produto foi modificado (Padrão ISO 8601)
user_log	Usuário que realizou a última alteração

Tabela de opções

ID	Nome
1	Normal
2	Sob Encomenda
3	Continuar comprando
4	Avise-me

Tabela de tipos

ID	Nome
back_to_sale	Continuar vendendo
warn_me	Avise-me
unavailable	Indisponivel

/product

Método responsável por retornar uma lista com informações dos produtos. Além de retornar algumas informações do produto, retornará também informações de promoções, descontos e seu respectivo estoque.

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/product

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os clientes retornados	Objeto em JSON
data product_id	ID do Produto	Numérico (int)
data model	Código do produto	String
data external_reference	Pode ser utilizado como referência externa do seu produto ou código do fabricante	String
data stock_status_id	Status do tempo de fabricação do produto	Numérico (int)
data image	Imagem principal do produto (Path interno)	String
data price	Preço do produto	String
data cost_price	Preço de custo do produto	String
data sale_price	Preço de venda do produto	String
data pos_price	Preço de venda no POS	String
data weight	Peso	String
data length	Comprimento	String
data width	Largura	String
data height	Altura	String
data sku	Muitas vezes utilizado como EAN / Código de barras	String
data minimum	Quantidade mínima de compra	String
data multiple_sales_quantity	Quantidade múltipla de compra	String
data status	Status do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data criticized	Flag indica que o produto foi criticado	Numérico (int)
data criticized_message	Mensagem comunicativa de que o produto foi criticado	String
data date_added	Data que o produto foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o produto foi modificado (Padrão ISO 8601)	String
data user_log	Usuário que realizou a última alteração	String
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Informações descritivas do produto	Objeto em JSON
data product_description language_id	ID da Língua configurada (Padrão para Português é "2")	Numérico (int)
data product_description name	Nome	String
data product_description description	Descrição	String
data product_description tag	Tags associadas ao produto	String
data product_description meta_title	Meta Título do produto (relevante para mecanismos de busca)	String
data product_description meta_description	Meta Descrição do produto (relevante para mecanismos de busca)	String
data product_description meta_keyword	Meta palavras-chave do produto (relevante para mecanismos de busca)	String
data product_description description_resume	Descrição resumida	String
data product_image	Imagens secundárias do produto	Objeto em JSON
data product_image image	Imagem (Path interno)	String
data product_to_category	Categorias na qual o produto se encontra	Objeto em JSON
data product_to_category category_id	ID da categoria	Numérico (int)
data product_to_category name	Nome da categoria	String
data product_special	Promoções configuradas para o produto específico	Objeto em JSON
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_special quantity	Quantidade do produto para que a promoção seja aplicada	Numérico (int)
data product_special price	Preço para o produto	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_discount	Descontos configurados para o produto específico	Objeto em JSON
data product_discount customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_discount quantity	Quantidade necessária para o desconto ser aplicado	Numérico (int)
data product_discount priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_discount price	Preço para o produto	Numérico (float)
data product_discount date_start	Data de início da promoção	String
data product_discount date_end	Data final da promoção	String
data product_option	Opções de estoque	Objeto em JSON
data product_option option_id	ID da opção "Pai"	Numérico (int)
data product_option name	Nome da opção	String
data product_option product_option_value	Objeto com as opções "filho"	Objeto em JSON
data product_option product_option_value option_value_id	ID da opção filho	Numérico (int)
data product_option product_option_value quantity	Quantidade em estoque	Numérico (int)
data product_option product_option_value price	Indica se tem uma alteração no preço original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product_option product_option_value price_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de preço	String
data product_option product_option_value weight	Indica se tem uma alteração no peso original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product_option product_option_value weight_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de peso	String
data product_image image	Imagens do produto	String
data ncm	Informações de NCM do produto	Objeto em JSON
data ncm name	Nome do NCM	String
data ncm ncm	Número do NCM	String
data url	URL do produto	String

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
        "previousPageUrl": null,
        "nextPageUrl": null,
        "firstItem": 1,
        "lastItem": 2
    },
    "data": [
        {
            "product_id": 48,
            "model": "0801",
            "image": "",
            "manufacturer_id": 0,
            "price": "1138.75",
            "cost_price": "0.00",
            "price_sale": "0.00",
            "price_pos": "0.00",
            "weight": "3.0000",
            "length": "0.0000",
            "width": "0.0000",
            "height": "0.0000",
            "sku": "7909159650921",
            "minimum": 1,
            "multiple_sales_quantity": 1,
            "status": 0,
            "criticized": 0,
            "criticized_message": null,
            "date_added": "2017-06-06 15:46:24",
            "date_modified": "2017-06-19 15:57:40",
            "user_log": "murilo-irroba",
            "approval_certificate": null,
            "product_description": [
                {
                    "language_id": 2,
                    "name": "Produto Teste",
                    "description": "",
                    "tag": "",
                    "meta_title": "Produto Teste",
                    "meta_description": "",
                    "meta_keyword": "",
                    "description_resume": ""
                }
            ],
            "product_image": [],
            "product_to_category": [
                {
                    "category_id": 240,
                    "name": "Equipe 1"
                }
            ],
            "product_special": [],
            "product_discount": [
                {
                    "customer_group_id": 8,
                    "quantity": 1,
                    "priority": 1,
                    "price": "100.00",
                    "date_start": "2017-05-31",
                    "date_end": "2017-06-15"
                }
            ],
            "product_option": [
                {
                    "option_id": 13,
                    "name": "Tamanho de Calçado Adulto",
                    "product_option_value": [
                        {
                            "option_value_id": 126,
                            "quantity": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "50"
                        },
                        {
                            "option_value_id": 125,
                            "quantity": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "49"
                        }
                        ...
                    ]
                }
            ],
            "product_image": [
                {
                    "image": "https://img.irroba.com.br/.../product1.jpeg"
                },
                {
                    "image": "https://img.irroba.com.br/.../product2.jpeg"
                }
            ],
            "ncm": {
                "name": "PRODUTO TESTE",
                "ncm": "9999.99.99"
            },
            "url": "produto-teste-1234"

/product/{{id}}

Método responsável por retornar os dados de um produto específico com todas suas informações.

Observação:Caso o parâmetro seja model, recomendamos que faça uso da rota /product/{model}/model.

Deverá ser realizado uma requisição GET informando o ID ou MODEL do produto.

GET https://api.irroba.com.br/v1/product/{{id}} ou {{model}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os clientes retornados	Objeto em JSON
data product_id	ID do Produto	Numérico (int)
data model	Código do produto	String
data external_reference	Pode ser utilizado como referência externa do seu produto ou código do fabricante	String
data stock_status_id	Status do tempo de fabricação do produto	Numérico (int)
data image	Imagem principal do produto (Path interno)	String
data manufacturer_id	ID do fabricante	Numérico (int)
data price	Preço do produto	String
data price_pos	Preço de venda no POS	String
data price_attacked	Preço de atacado do produto	String
data cost_price	Preço de custo do produto	String
data weight	Peso	String
data length	Comprimento	String
data width	Largura	String
data height	Altura	String
data subtract	Controle de estoque do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data sku	Muitas vezes utilizado como EAN / Código de barras	String
data minimum	Quantidade mínima de compra	String
data multiple_sales_quantity	Quantidade múltipla de compra	String
data status	Status do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data criticized	Flag indica que o produto foi criticado	Numérico (int)
data criticized_message	Mensagem comunicativa de que o produto foi criticado	String
data date_added	Data que o produto foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o produto foi modificado (Padrão ISO 8601)	String
data user_log	Usuário que realizou a última alteração	String
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Informações descritivas do produto	Objeto em JSON
data product_description language_id	ID da Língua configurada (Padrão para Português é "2")	Numérico (int)
data product_description name	Nome	String
data product_description description	Descrição	String
data product_description tag	Tags associadas ao produto	String
data product_description meta_title	Meta Título do produto (relevante para mecanismos de busca)	String
data product_description meta_description	Meta Descrição do produto (relevante para mecanismos de busca)	String
data product_description meta_keyword	Meta palavras-chave do produto (relevante para mecanismos de busca)	String
data product_description description_resume	Descrição resumida	String
data product_image	Imagens secundárias do produto	Objeto em JSON
data product_image image	Imagem (Path interno)	String
data product_to_category	Categorias na qual o produto se encontra	Objeto em JSON
data product_to_category category_id	ID da categoria	Numérico (int)
data product_to_category name	Nome da categoria	String
data product_special	Promoções configuradas para o produto específico	Objeto em JSON
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_special price	Preço para o produto	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_discount	Descontos configurados para o produto específico	Objeto em JSON
data product_discount customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_discount quantity	Quantidade necessária para o desconto ser aplicado	Numérico (int)
data product_discount priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_discount price	Preço para o produto	Numérico (float)
data product_discount date_start	Data de início da promoção	String
data product_discount date_end	Data final da promoção	String
data product_option	Opções de estoque	Objeto em JSON
data product_option option_id	ID da opção "Pai"	Numérico (int)
data product_option name	Nome da opção	String
data product_option product_option_value	Objeto com as opções "filho"	Objeto em JSON
data product_option product_option_value option_value_id	ID da opção filho	Numérico (int)
data product_option product_option_value quantity	Quantidade em estoque	Numérico (int)
data product_option product_option_value subtract	Controle de estoque da opção, 1 para habilitado, 0 para desabilitado	Numérico (int)
data product_option product_option_value price	Indica se tem uma alteração no preço original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product_option product_option_value price_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de preço	String
data product_option product_option_value weight	Indica se tem uma alteração no peso original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product_option product_option_value weight_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de peso	String
data product_like	Json com informações das categorias de produtos semelhantes	JSON
data product_like like_id	Id dos produtos semelhantes, Os Ids podem ser consultados no seguinte método Produtos	Numérico (int)
data ncm	Informações de NCM do produto	Objeto em JSON
data ncm name	Nome do NCM	String
data ncm ncm	Número do NCM	String

{
    "success": "true",
    "data": [
        {
            "product_id": 48,
            "model": "0801",
            "image": "",
            "manufacturer_id": 0,
            "price": "1138.75",
            "price_pos": "0.00",
            "price_attacked": "0.00",
            "cost_price": "0.00",
            "weight": "3.0000",
            "length": "0.0000",
            "width": "0.0000",
            "height": "0.0000",
            "subtract": 1,
            "sku": "7909159650921",
            "minimum": 1,
            "multiple_sales_quantity": 1,
            "status": 0,
            "criticized": 0,
            "criticized_message": null,
            "date_added": "2017-06-06 15:46:24",
            "date_modified": "2017-06-19 15:57:40",
            "user_log": "murilo-irroba",
            "approval_certificate": null,
            "product_description": [
                {
                    "language_id": 2,
                    "name": "Produto Teste",
                    "description": "",
                    "tag": "",
                    "meta_title": "Produto Teste",
                    "meta_description": "",
                    "meta_keyword": "",
                    "description_resume": ""
                }
            ],
            "product_image": [],
            "product_to_category": [
                {
                    "category_id": 240,
                    "name": "Equipe 1"
                }
            ],
            "product_special": [],
            "product_discount": [
                {
                    "customer_group_id": 8,
                    "quantity": 1,
                    "priority": 1,
                    "price": "100.00",
                    "date_start": "2017-05-31",
                    "date_end": "2017-06-15"
                }
            ],
            "product_option": [
                {
                    "option_id": 13,
                    "name": "Tamanho de Calçado Adulto",
                    "product_option_value": [
                        {
                            "option_value_id": 126,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "50"
                        },
                        {
                            "option_value_id": 125,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "49"
                        },
                        {
                            "option_value_id": 124,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "48"
                        },
                        {
                            "option_value_id": 51,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "35"
                        },
                        {
                            "option_value_id": 49,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "33"
                        },
                        {
                            "option_value_id": 50,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "34"
                        },
                        {
                            "option_value_id": 123,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "47"
                        },
                        {
                            "option_value_id": 122,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "46"
                        },
                        {
                            "option_value_id": 121,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "45"
                        },
                        {
                            "option_value_id": 120,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "44"
                        },
                        {
                            "option_value_id": 119,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "43"
                        },
                        {
                            "option_value_id": 118,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "42"
                        },
                        {
                            "option_value_id": 117,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "41"
                        },
                        {
                            "option_value_id": 116,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "40"
                        },
                        {
                            "option_value_id": 115,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "39"
                        },
                        {
                            "option_value_id": 114,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "38"
                        },
                        {
                            "option_value_id": 113,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "37"
                        },
                        {
                            "option_value_id": 52,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "36"
                        }
                    ]
                }
            ],
            "product_like":[
                {
                    "like_id":"12"
                }
            ],
            "ncm": {
                "name": "PRODUTO TESTE",
                "ncm": "9999.99.99"
            }
        }
    ]
}

/product/{{model}}/model

Método responsável por retornar os dados de um produto específico com todas suas informações.

Deverá ser realizado uma requisição GET informando o MODEL do produto.

GET https://api.irroba.com.br/v1/product/{{model}}/model

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os clientes retornados	Objeto em JSON
data product_id	ID do Produto	Numérico (int)
data model	Código do produto	String
data external_reference	Pode ser utilizado como referência externa do seu produto ou código do fabricante	String
data stock_status_id	Status do tempo de fabricação do produto	Numérico (int)
data image	Imagem principal do produto (Path interno)	String
data manufacturer_id	ID do fabricante	Numérico (int)
data price	Preço do produto	String
data price_pos	Preço de venda no POS	String
data price_attacked	Preço de atacado do produto	String
data cost_price	Preço de custo do produto	String
data weight	Peso	String
data length	Comprimento	String
data width	Largura	String
data height	Altura	String
data subtract	Controle de estoque do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data sku	Muitas vezes utilizado como EAN / Código de barras	String
data minimum	Quantidade mínima de compra	String
data multiple_sales_quantity	Quantidade múltipla de compra	String
data status	Status do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data criticized	Flag indica que o produto foi criticado	Numérico (int)
data criticized_message	Mensagem comunicativa de que o produto foi criticado	String
data date_added	Data que o produto foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o produto foi modificado (Padrão ISO 8601)	String
data user_log	Usuário que realizou a última alteração	String
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Informações descritivas do produto	Objeto em JSON
data product_description language_id	ID da Língua configurada (Padrão para Português é "2")	Numérico (int)
data product_description name	Nome	String
data product_description description	Descrição	String
data product_description tag	Tags associadas ao produto	String
data product_description meta_title	Meta Título do produto (relevante para mecanismos de busca)	String
data product_description meta_description	Meta Descrição do produto (relevante para mecanismos de busca)	String
data product_description meta_keyword	Meta palavras-chave do produto (relevante para mecanismos de busca)	String
data product_description description_resume	Descrição resumida	String
data product_image	Imagens secundárias do produto	Objeto em JSON
data product_image image	Imagem (Path interno)	String
data product_to_category	Categorias na qual o produto se encontra	Objeto em JSON
data product_to_category category_id	ID da categoria	Numérico (int)
data product_to_category name	Nome da categoria	String
data product_special	Promoções configuradas para o produto específico	Objeto em JSON
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_special price	Preço para o produto	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_discount	Descontos configurados para o produto específico	Objeto em JSON
data product_discount customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_discount quantity	Quantidade necessária para o desconto ser aplicado	Numérico (int)
data product_discount priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_discount price	Preço para o produto	Numérico (float)
data product_discount date_start	Data de início da promoção	String
data product_discount date_end	Data final da promoção	String
data product_option	Opções de estoque	Objeto em JSON
data product_option option_id	ID da opção "Pai"	Numérico (int)
data product_option name	Nome da opção	String
data product_option product_option_value	Objeto com as opções "filho"	Objeto em JSON
data product_option product_option_value option_value_id	ID da opção filho	Numérico (int)
data product_option product_option_value quantity	Quantidade em estoque	Numérico (int)
data product_option product_option_value subtract	Controle de estoque da opção, 1 para habilitado, 0 para desabilitado	Numérico (int)
data product_option product_option_value price	Indica se tem uma alteração no preço original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product_option product_option_value price_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de preço	String
data product_option product_option_value weight	Indica se tem uma alteração no peso original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product_option product_option_value weight_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de peso	String
data product_like	Json com informações das categorias de produtos semelhantes	JSON
data product_like like_id	Id dos produtos semelhantes, Os Ids podem ser consultados no seguinte método Produtos	Numérico (int)
data ncm	Informações de NCM do produto	Objeto em JSON
data ncm name	Nome do NCM	String
data ncm ncm	Número do NCM	String

{
    "success": "true",
    "data": [
        {
            "product_id": 48,
            "model": "0801",
            "image": "",
            "manufacturer_id": 0,
            "price": "1138.75",
            "price_pos": "0.00",
            "price_attacked": "0.00",
            "cost_price": "0.00",
            "weight": "3.0000",
            "length": "0.0000",
            "width": "0.0000",
            "height": "0.0000",
            "subtract": 1,
            "sku": "7909159650921",
            "minimum": 1,
            "multiple_sales_quantity": 1,
            "status": 0,
            "criticized": 0,
            "criticized_message": null,
            "date_added": "2017-06-06 15:46:24",
            "date_modified": "2017-06-19 15:57:40",
            "user_log": "murilo-irroba",
            "approval_certificate": null,
            "product_description": [
                {
                    "language_id": 2,
                    "name": "Produto Teste",
                    "description": "",
                    "tag": "",
                    "meta_title": "Produto Teste",
                    "meta_description": "",
                    "meta_keyword": "",
                    "description_resume": ""
                }
            ],
            "product_image": [],
            "product_to_category": [
                {
                    "category_id": 240,
                    "name": "Equipe 1"
                }
            ],
            "product_special": [],
            "product_discount": [
                {
                    "customer_group_id": 8,
                    "quantity": 1,
                    "priority": 1,
                    "price": "100.00",
                    "date_start": "2017-05-31",
                    "date_end": "2017-06-15"
                }
            ],
            "product_option": [
                {
                    "option_id": 13,
                    "name": "Tamanho de Calçado Adulto",
                    "product_option_value": [
                        {
                            "option_value_id": 126,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "50"
                        },
                        {
                            "option_value_id": 125,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "49"
                        },
                        {
                            "option_value_id": 124,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "48"
                        },
                        {
                            "option_value_id": 51,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "35"
                        },
                        {
                            "option_value_id": 49,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "33"
                        },
                        {
                            "option_value_id": 50,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "34"
                        },
                        {
                            "option_value_id": 123,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "47"
                        },
                        {
                            "option_value_id": 122,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "46"
                        },
                        {
                            "option_value_id": 121,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "45"
                        },
                        {
                            "option_value_id": 120,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "44"
                        },
                        {
                            "option_value_id": 119,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "43"
                        },
                        {
                            "option_value_id": 118,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "42"
                        },
                        {
                            "option_value_id": 117,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "41"
                        },
                        {
                            "option_value_id": 116,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "40"
                        },
                        {
                            "option_value_id": 115,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "39"
                        },
                        {
                            "option_value_id": 114,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "38"
                        },
                        {
                            "option_value_id": 113,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "37"
                        },
                        {
                            "option_value_id": 52,
                            "quantity": 1,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "36"
                        }
                    ]
                }
            ],
            "product_like":[
                {
                    "like_id":"12"
                }
            ],
            "ncm": {
                "name": "PRODUTO TESTE",
                "ncm": "9999.99.99"
            }
        }
    ]
}

/product/lists

Método responsável por retornar as listas de produtos inseridas na loja, conterá também todas as informações dos produtos vinculados a ela.

GET https://api.irroba.com.br/v1/product/lists

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos informações da lista	Objeto em JSON
data name	Nome da lista de produtos	String
data status	Status da lista	Numérico (int)
data product product_id	ID do Produto	Numérico (int)
data product model	Código do produto	String
data product external_reference	Pode ser utilizado como referência externa do seu produto ou código do fabricante	String
data product stock_status_id	Status do tempo de fabricação do produto	Numérico (int)
data product image	Imagem principal do produto (Path interno)	String
data product price	Preço do produto	Numérico (float)
data product cost_price	Preço de custo do produto	Numérico (float)
data product weight	Peso	Numérico (float)
data product length	Comprimento	Numérico (float)
data product width	Largura	Numérico (float)
data product height	Altura	Numérico (float)
data product status	Status do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data product date_added	Data que o produto foi adicionado (Padrão ISO 8601)	String
data product date_modified	Data que o produto foi modificado (Padrão ISO 8601)	String
data product user_log	Usuário que realizou a última alteração	String
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product product_description	Informações descritivas do produto	Objeto em JSON
data product product_description language_id	ID da Língua configurada (Padrão para Português é "2")	Numérico (int)
data product product_description name	Nome	String
data product product_description description	Descrição	String
data product product_description tag	Tags associadas ao produto	String
data product product_description meta_title	Meta Título do produto (relevante para mecanismos de busca)	String
data product product_description meta_description	Meta Descrição do produto (relevante para mecanismos de busca)	String
data product product_description meta_keyword	Meta palavras-chave do produto (relevante para mecanismos de busca)	String
data product product_description description_resume	Descrição resumida	String
data product product_image	Imagens secundárias do produto	Objeto em JSON
data product product_image image	Imagem (Path interno)	String
data product product_to_category	Categorias na qual o produto se encontra	Objeto em JSON
data product product_to_category category_id	ID da categoria	Numérico (int)
data product product_to_category name	Nome da categoria	String
data product product_special	Promoções configuradas para o produto específico	Objeto em JSON
data product product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product product_special price	Preço para o produto	Numérico (float)
data product product_special date_start	Data de início da promoção	String
data product product_special date_end	Data final da promoção	String
data product product_discount	Descontos configurados para o produto específico	Objeto em JSON
data product product_discount customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product product_discount quantity	Quantidade necessária para o desconto ser aplicado	Numérico (int)
data product product_discount priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product product_discount price	Preço para o produto	Numérico (float)
data product product_discount date_start	Data de início da promoção	String
data product product_discount date_end	Data final da promoção	String
data product product_option	Opções de estoque	Objeto em JSON
data product product_option option_id	ID da opção "Pai"	Numérico (int)
data product product_option name	Nome da opção	String
data product product_option product_option_value	Objeto com as opções "filho"	Objeto em JSON
data product product_option product_option_value option_value_id	ID da opção filho	Numérico (int)
data product product_option product_option_value quantity	Quantidade em estoque	Numérico (int)
data product product_option product_option_value price	Indica se tem uma alteração no preço original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product product_option product_option_value price_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de preço	String
data product product_option product_option_value weight	Indica se tem uma alteração no peso original do produto (Irá somar ou subtrair do valor original)	Numérico float
data product product_option product_option_value weight_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de peso	String

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
        "previousPageUrl": null,
        "nextPageUrl": null,
        "firstItem": 1,
        "lastItem": 2
    },
    "data": [
        {
            "name": "VITRINE DE PRODUTOS DO PDV",
            "status": "0",
            "products": [
                {
                    "product_id": 1,
                    "model": "netshoes",
                    "image": "",
                    "manufacturer_id": 8,
                    "price": "683.89",
                    "cost_price": "0.00",
                    "weight": "0.0000",
                    "length": "0.0000",
                    "width": "0.0000",
                    "height": "0.0000",
                    "status": 0,
                    "date_added": "2017-02-16 10:14:56",
                    "date_modified": "2017-05-03 13:29:12",
                    "user_log": "machado-irroba",
                    "approval_certificate": null,
                    "product_description": [
                        {
                            "language_id": 2,
                            "name": "Produto Teste",
                            "description": "<p>sadsadsadad</p>",
                            "tag": "",
                            "meta_title": "Produto Teste",
                            "meta_description": "",
                            "meta_keyword": "",
                            "description_resume": ""
                        }
                    ],
                    "product_image": [],
                    "product_special": [
                        {
                            "customer_group_id": 8,
                            "priority": 0,
                            "price": "4500.00",
                            "date_start": "2016-10-31",
                            "date_end": "2016-12-10"
                        },
                        {
                            "customer_group_id": 8,
                            "priority": 0,
                            "price": "15.00",
                            "date_start": "2017-03-27",
                            "date_end": "2017-04-30"
                        }
                    ],
                    "product_discount": [],
                    "product_option": {
                        "option_id": 29,
                        "name": "Único",
                        "product_option_value": {
                            "option_value_id": 255,
                            "quantity": 9998,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "name": "Único"
                        }
                    }
                }
            ]
        },
        {
            "name": "NOSSOS DESTAQUES",
            "status": "1",
            "products": []
        }
    ]
}

/product/category/{{id}}

Método responsável por retornar uma lista com informações dos produtos de acordo com a categoria definida.

GET https://api.irroba.com.br/v1/product/category/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos informações da lista	Objeto em JSON
data product_id	ID do Produto	Numérico (int)
data model	Código do produto	String
data image	Imagem principal do produto (Path interno)	String
data external_reference	Pode ser utilizado como referência externa do seu produto ou código do fabricante	String
data manufacturer_id	ID do Fabricante	Numérico (int)
data price	Preço do produto	String
data cost_price	Preço de custo do produto	String
data weight	Peso	String
data length	Comprimento	String
data width	Largura	String
data height	Altura	String
data status	Status do produto, 1 para habilitado, 0 para desabilitado	Numérico (int)
data date_added	Data que o produto foi adicionado (Padrão ISO 8601)	String
data date_modified	Data que o produto foi modificado (Padrão ISO 8601)	String
data user_log	Usuário que realizou a última alteração	String
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Informações descritivas do produto	Objeto em JSON
data product_description language_id	ID da Língua configurada (Padrão para Português é "2")	Numérico (int)
data product_description name	Nome	String
data product_description description	Descrição	String
data product_description tag	Tags associadas ao produto	String
data product_description meta_title	Meta Título do produto (relevante para mecanismos de busca)	String
data product_description meta_description	Meta Descrição do produto (relevante para mecanismos de busca)	String
data product_description meta_keyword	Meta palavras-chave do produto (relevante para mecanismos de busca)	String
data product_description description_resume	Descrição resumida	String
data product_image	Imagens secundárias do produto	Objeto em JSON
data product_image image	Imagem (Path interno)	String
data product_special	Promoções configuradas para o produto específico	Objeto em JSON
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_special price	Preço para o produto	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_discount	Descontos configurados para o produto específico	Objeto em JSON
data product_discount customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_discount quantity	Quantidade necessária para o desconto ser aplicado	Numérico (int)
data product_discount priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_discount price	Preço para o produto	String
data product_discount date_start	Data de início da promoção	String
data product_discount date_end	Data final da promoção	String
data product_option	Opções de estoque	Objeto em JSON
data product_option option_id	ID da opção "Pai"	Numérico (int)
data product_option name	Nome da opção	String
data product_option product_option_value	Objeto com as opções "filho"	Objeto em JSON
data product_option product_option_value option_value_id	ID da opção filho	Numérico (int)
data product_option product_option_value quantity	Quantidade em estoque	Numérico (int)
data product_option product_option_value price	Indica se tem uma alteração no preço original do produto (Irá somar ou subtrair do valor original)	String
data product_option product_option_value price_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de preço	String
data product_option product_option_value weight	Indica se tem uma alteração no peso original do produto (Irá somar ou subtrair do valor original)	String
data product_option product_option_value weight_prefix	Indica se será um acréscimo "+" ou decréscimo "-" de peso	String

{
    "success": "true",
    "pagination": {
        "currentPage": 1,
        "previousPageUrl": null,
        "nextPageUrl": null,
        "firstItem": 1,
        "lastItem": 1
    },
    "data": [
        {
            "product_id": 1,
            "model": "1234",
            "image": "",
            "manufacturer_id": 8,
            "price": "683.89",
            "cost_price": "0.00",
            "weight": "0.0000",
            "length": "0.0000",
            "width": "0.0000",
            "height": "0.0000",
            "status": 0,
            "date_added": "2017-02-16 10:14:56",
            "date_modified": "2017-05-03 13:29:12",
            "user_log": "user",
            "approval_certificate": null,
            "product_description": [
                {
                    "language_id": 2,
                    "name": "Produto Teste",
                    "description": "<p>Descrição do produto!</p>",
                    "tag": "",
                    "meta_title": "Produto Teste",
                    "meta_description": "",
                    "meta_keyword": "",
                    "description_resume": ""
                }
            ],
            "product_image": [],
            "product_special": [
                {
                    "customer_group_id": 8,
                    "priority": 0,
                    "price": "4500.00",
                    "date_start": "2016-10-31",
                    "date_end": "2016-12-10"
                },
                {
                    "customer_group_id": 8,
                    "priority": 0,
                    "price": "15.00",
                    "date_start": "2017-03-27",
                    "date_end": "2017-04-30"
                }
            ],
            "product_discount": [],
            "product_option": {
                "option_id": 29,
                "name": "Único",
                "product_option_value": {
                    "option_value_id": 255,
                    "quantity": 9998,
                    "price": "0.00",
                    "price_prefix": "+",
                    "weight": "0.0000",
                    "weight_prefix": "+",
                    "name": "Único"
                }
            }
        }
    ]
}

/product

Método responsável por adicionar um produto.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/product

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do produto	Objeto em JSON
data model	Código do Produto	String / Obrigatório / Máximo de 120 caracteres
data SKU	Código de Barras de 8 - 13 Dígitos	String
data external_reference	Referência externa do seu produto	String Máximo de 100 caracteres
data price	Preço do Produto	Numérico (float) / Obrigatório
data status	Status do Produto (1 Habilitado 0 Desabilitado)	Numérico (int) / Obrigatório
data minimum	Quantidade mínima de compra. Se a quantidade mínima de compra for menor que a múltipla, o mínimo será salvo igual ao valor do múltiplo	String
data multiple_sales_quantity	Quantidade múltipla de compra. Se a quantidade mínima de compra for menor que a múltipla, o mínimo será salvo igual ao valor do múltiplo	String
data manufacturer_id	Id da Marca do produto, Buscar Ids das Marcas cadastradas na loja Marcas	Numérico (int)
data manufacturer	Json com as informações da marca do produto (enviar somente quando o manufacturer_id não existir) / Opção valida se existe alguma marca com esse nome, caso exista vincula a mesma ao produto, caso contrario cria uma nova marca e vincula ao produto.	JSON
data manufacturer name	Nome do Fabricante	String
data manufacturer sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	Numérico(int)
data price_attacked	Preço de atacado do produto	Numérico (float)
data cost_price	Preço de custo do produto	Numérico (float)
data weight	Peso do Produto	Numérico (float) / Obrigatório
data length	Comprimento	Numérico (float)
data width	Largura	Numérico (float)
data height	Altura	Numérico (float)
data feed_gender	Gênero do produto que sera enviado para o google (male,female,unisex)	Numérico (float)
data sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Json com informações da descrição do produto	JSON / Obrigatório
data product_description name	Nome do Produto	String / Obrigatório / Máximo de 300 caracteres
data product_description description	Descrição do Produto	String / Máximo de 2500 caracteres
data product_description meta_attribute_alt	Meta Atributo do Produto	String
data product_description meta_title	Meta Titulo do Produto	String
data product_description description_resume	Descrição resumida do Produto	String
data product_description meta_description	Meta Descrição do Produto	String
data product_description tag	Tags do produto (devem ser separadas por virgula)	String
data product_option	Json com informações das opções de estoque do produto	JSON
data product_option option_id	Id da opção, Conforme as opções disponiveis Opções	Numérico (int)
data product_option required	Se a opção é obrigatória ou não (True ou False)	bool
data product_option principal	Se a opção é principal do produto ou não (True ou False)	bool
data product_option grid_stock	Se a opção é grade de estoque (True ou False)	bool
data product_option package_name	Nome do pacote do produto	string
data product_option calculation_simulator	Se caso o produto for type square, ele habilita o cálculo de metragens	bool
data product_option product_option_value	Json com informações das variações do produto	Json
data product_option product_option_value option_value_id	Id da variação, Conforme as opções disponiveis Opções	Json
data product_option product_option_value quantity	Quantidade em estoque da variação (Enviando o estoque negativo será automaticamente considerado como zero)	Numérico (int)
data product_option product_option_value reference	Referência da opção de estoque (Utilizada para atualização de quantidades)	String
data product_option product_option_value external_reference	Referência externa utilizado para inserir o ID da opção de estoque em seu ERP	String
data product_option product_option_value price	Preço da opção de estoque (Preencher este campo somente quando a variação de estoque possuir preço diferente do produto)	String
data product_option product_option_value subtract	Informa se a variação controla estoque	bool
data product_option product_option_value stock_type	Ação do estoque com a quantidade zerada, você pode verificar as ações disponiveis na seguinte Tabela (Caso não enviado por padrão a opção será o Avise-me "warn_me")	String
data product_to_category	Json com informações das categorias do produto	JSON
data product_to_category category_id	Id da categoria, Os Ids podem ser consultados no seguinte método Categorias (Deve ser enviada somente uma das opções category_id ou reference)	Numérico (int)
data product_to_category reference	Referência da categoria (Deve ser enviada somente uma das opções category_id ou reference)	String
data product_like	Json com informações das categorias de produtos semelhantes	JSON
data product_like like_id	Id dos produtos semelhantes, Os Ids podem ser consultados no seguinte método Produtos (Deve ser enviada somente uma das opções like_id ou model)	Numérico (int)
data product_like model	Model do Produto (Deve ser enviada somente uma das opções like_id ou model)	String
data product_image	Json com as imagens dos produtos (Máximo de 5 imagens por produto)	JSON
data product_image url	URL da imagem (Deve ser enviada somente uma das opções url ou base64)	String
data product_image base_64	BASE64 da imagem (Deve ser enviada somente uma das opções url ou base64)	String
data product_image main_image	Define se é a imagem principal do produto (True ou False)	bool
data product_image sort_order	Ordenação na exibição da Imagem (Do menor para o maior)	Numérico (int)
data product_special	Json com informações das promoções do produto	JSON
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_special quantity	Quantidade do produto para que a promoção seja aplicada. Caso não seja informado, será considerado como 1	Numérico (int)
data product_special price	Preço para o produto. (Este campo só é considerado caso o price_type NÃO seja "discount")	Numérico (float)
data product_special price_type	Tipo de desconto, para "porcentagem enviar discount", "preço fixo enviar fixed". (Caso não enviado o campo por padrão o valor é fixed)	String
data product_special payment_id	Forma de pagamento em que a promoção será limitada. Opções disponíveis (1- Cartão, 2- Boleto, 3- Pix, 4- Pix Parcelado, 5- Transferência Bancária, 6- Depósito). Caso não seja informado nenhum ID citado (1,2,3,4,5,6) o padrão será a criação da promoção para todas formas de pagamento	Numérico (int)
data product_special discount	Valor de desconto para a promoção, "Ex: 10.00 para o desconto de 10%".(Este campo somente é considerado caso o price_type seja "discount")	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_discount	Json com informações do desconto do produto	JSON
data product_discount priority	Prioridade do desconto, caso ocorra conflito com outras a com menor valor será priorizada	Numérico (int)
data product_discount quantity	Quantidade de produtos para que o desconto seja aplicado (padrão é 1)	Numérico (int)
data product_discount price_type	Tipo de desconto, para "porcentagem enviar percent", "preço fixo enviar fixed". (Caso não enviado o campo por padrão o valor é fixed)	String
data product_discount value_discount	Valor de desconto, "Ex: 10,00 para o desconto de 10% ou R$ 10,00 dependendo do price_type"	String
data product_discount date_start	Data de início do desconto	String
data product_discount date_end	Data final do desconto	String
data product_discount customer_group_id	ID do grupo de usuários que poderá utilizar desse desconto ("8" é o valor para o grupo de usuários Default)	Numérico (int)
data product_attribute	Json com os atributos do produto	JSON
data product_attribute group	Nome do grupo de atributos	String
data product_attribute attribute	Nome do atributo	String
data product_attribute text	Texto de informações sobre o atributo	String
data product_attribute enable_view	Informa se o atributo sera exibido no front (true para não exibir no front)	Bool

{
    "model" : "ABC12345",
    "sku": "sku_info",
    "price" : "1.200,00",
    "status": 1,
    "minimum": 1,
    "multiple_sales_quantity": 1,
    "manufacturer_id": 33,
    "manufacturer": { //Caso manufacturer_id seja enviado o JSON manufacturer sera desconsiderado
		"name" : "Marca teste",
		"sort_order": 1
	},
    "price_attacked": "300,00",
    "cost_price": "220,00",
    "weight": 4,
    "length": 3,
    "width": 6,
    "height": 4,
    "feed_gender": "male",
    "sort_order": 3,
    "approval_certificate": null,
    "product_description": [
        {
            "name"  : "Produto Teste API",
            "description":"As descrições dos produtos para e-commerce deles incluem vários detalhes técnicos.",
            "meta_attribute_alt": "teste 3",
            "meta_title": "teste",
            "description_resume": "teste resume",
            "meta_description":"teste 5",
            "tag": "abc123,teste3,123teste"
        }
    ],
    "product_option": [
        {
            "option_id": 18,
            "required": true,
            "principal" : true,
            "grid_stock": false,
            "package_name": "Caixa",
            "calculation_simulator": 1,
            "product_option_value":[
                {
                    "option_value_id": 9998,
                    "quantity": 10,
                    "reference": "teste44",
                    "price": "130,00",
                    "subtract": true,
                },
                {
                    "option_value_id": 130,
                    "quantity": 15,
                    "reference": "DDD448792c",
                    "external_reference": "1234-887"
                }
            ]
        }
    ],
    "product_to_category":[
        {
            "category_id": 33
        },
        {
            "reference": "44573"
        }
    ],
    "product_like":[
        {
            "model":"011115"
        },
        {
            "like_id":"12"
        }
    ],
    "product_image": [
      {
        "url": "https://img.irroba.com.br/irroba/cancun.jpg",
        "main_image": true,
        "sort_order": 0
      },
      {
        "base_64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
        "main_image": false,
        "sort_order": 1
      }
    ],
    "product_special":[
        {
            "priority": 0,
            "quantity": 1,
            "price"   : "100,00",
            "date_start":"30-01-2017 10:49:32",
            "date_end":"30-05-2017 10:49:32"
        },
        {
            "priority": 1,
            "price"   : "60,00",
            "date_start":"30-05-2019 10:49:32",
            "date_end":"30-05-2032 10:49:32"
        }
    ],
    "product_attribute": [
        {
            "group": "Voltagem",
            "attribute": "110v",
            "text": "Atributo teste",
            "enable_view": false
        }
]
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Product inserted successfully!",
        "product_id": 10172
    }
}

/product/{id}

Método responsável por alterar um produto.

Observação:Caso o parâmetro seja model, recomendamos que faça uso da rota /product/{model}/model.

Deverá ser realizado uma requisição PUT com o request necessário.

PUT https://api.irroba.com.br/v1/product/{id} ou {{model}}

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do produto	Objeto em JSON
data model	Código do Produto	String Máximo de 120 caracteres
data external_reference	Referência externa do seu produto	String Máximo de 100 caracteres
data sku	Sku (Código de Barras de 8 - 13 Dígitos)	String Máximo de 120 caracteres
data price	Preço do Produto	String
data status	Status do Produto (1 Habilitado 0 Desabilitado)	Numérico (int)
data minimum	Quantidade mínima de compra. Se a quantidade mínima de compra for menor que a múltipla, o mínimo será salvo igual ao valor do múltiplo	String
data multiple_sales_quantity	Quantidade múltipla de compra. Se a quantidade mínima de compra for menor que a múltipla, o mínimo será salvo igual ao valor do múltiplo	String
data manufacturer_id	Id da Marca do produto, Buscar Ids das Marcas cadastradas na loja Marcas	Numérico (int)
data manufacturer	Json com as informações da marca do produto (enviar somente quando o manufacturer_id não existir) / Opção valida se existe alguma marca com esse nome, caso exista vincula a mesma ao produto, caso contrario cria uma nova marca e vincula ao produto.	JSON
data manufacturer name	Nome do Fabricante	String
data manufacturer sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	Numérico(int)
data price_attacked	Preço de atacado do produto	String
data cost_price	Preço de custo do produto	String
data weight	Peso do Produto	Numérico (float)
data length	Comprimento	Numérico (float)
data width	Largura	Numérico (float)
data height	Altura	Numérico (float)
data feed_gender	Gênero do produto que sera enviado para o google (male,female,unisex)	Numérico (float)
data sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Json com informações da descrição do produto	JSON
data product_description name	Nome do Produto	String / Máximo de 300 caracteres
data product_description description	Descrição do Produto	String / Máximo de 2500 caracteres
data product_description description_resume	Descrição resumida do Produto	String
data product_description tag	Tags do produto (devem ser separadas por virgula)	String
data product_image	Json com informações das imagens do produto (Todas as outras imagens cadastrada neste produto serão deletadas quando este campo é enviado)	JSON
data product_image url	URL da imagem (Deve ser enviada somente uma das opções url ou base64)	String
data product_image base_64	BASE64 da imagem (Deve ser enviada somente uma das opções url ou base64)	String
data product_image main_image	Define se é a imagem principal do produto (True ou False)	Bool
data product_image sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data product_special	Json com informações das promoções do produto (Todas as outras promoções cadastrada neste produto serão deletadas quando este campo é enviado)	JSON
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizadao	Numérico (int)
data product_special quantity	Quantidade do produto para que a promoção seja aplicada. Caso não seja informado, será considerado como 1	Numérico (int)
data product_special price	Preço para o produto. (Este campo só é considerado caso o price_type NÃO seja "discount")	Numérico (float)
data product_special price_type	Tipo de desconto, para "porcentagem enviar discount", "preço fixo enviar fixed". (Caso não enviado o campo por padrão o valor é fixed)	String
data product_special payment_id	Forma de pagamento em que a promoção será limitada. Opções disponíveis (1- Cartão, 2- Boleto, 3- Pix, 4- Pix Parcelado, 5- Transferência Bancária, 6- Depósito). Caso não seja informado nenhum ID citado (1,2,3,4,5,6) o padrão será a criação da promoção para todas formas de pagamento	Numérico (int)
data product_special discount	Valor de desconto para a promoção, "Ex: 10.00 para o desconto de 10%".(Este campo somente é considerado caso o price_type seja "discount")	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	String
data product_like	Json com informações das categorias de produtos semelhantes (Todas os outros produtos semelhantes neste produto serão deletadas quando este campo é enviado)	JSON
data product_like like_id	Id dos produtos semelhantes, Os Ids podem ser consultados no seguinte método Produtos (Deve ser enviada somente uma das opções like_id ou model)	Numérico (int)
data product_like model	Model do Produto (Deve ser enviada somente uma das opções like_id ou model)	String
data product_to_category	Json com informações das categorias do produto (Todas as outras categorias vinculadas neste produto serão removidas quando este campo é enviado)	JSON
data product_to_category category_id	Id da categoria, Os Ids podem ser consultados no seguinte método Categorias (Deve ser enviada somente uma das opções category_id ou reference)	Numérico (int)
data product_to_category reference	Referência da categoria (Deve ser enviada somente uma das opções category_id ou reference)	String
data product_attribute	Json com os atributos do produto	JSON
data product_attribute group	Nome do grupo de atributos	String
data product_attribute attribute	Nome do atributo	String
data product_attribute text	Texto de informações sobre o atributo	String
data product_attribute enable_view	Informa se o atributo sera exibido no front (true para não exibir no front)	Bool
price_b2w	Preço para a B2W	String
special_price_b2w	Preço promocional para a B2W	String
price_carrefour	Preço para o Carrefour	String
special_price_carrefour	Preço promocional para o Carrefour	String
price_centauro	Preço para a Centauro	String
special_price_centauro	Preço promocional para a Centauro	String
price_dafiti	Preço para a Dafiti	String
special_price_dafiti	Preço promocional para a Dafiti	String
start_date_special_dafiti	Data de início da promoção	String / Obrigatório caso envie o preço promocional
end_date_special_dafiti	Data do fim da promoção	String / Obrigatório caso envie o preço promocional
price_magazine	Preço para o Magazine	String
special_price_magazine	Preço promocional para o Magazine	String
price_mercadolivre	Preço para o Mercado Livre	String
price_shopee	Preço para a Shopee	Numérico (float)
price_netshoes	Preço para a Netshoes	String
special_price_netshoes	Preço promocional para a Netshoes	String
price_viavarejo	Preço para a Via Varejo	String
special_price_viavarejo	Preço promocional para a Via Varejo	String

{
    "model" : "ABC12345",
    "sku" : "12344477886",
    "price" : "1.200,00",
    "status": 1,
    "minimum": 1,
    "multiple_sales_quantity": 1,
    "manufacturer_id": 33,
    "manufacturer": { //Caso manufacturer_id seja enviado o JSON manufacturer sera desconsiderado
		"name" : "Marca teste",
		"sort_order": 1
	},
    "price_attacked": "300,00",
    "cost_price": "220,00",
    "weight": 4,
    "length": 3,
    "width": 6,
    "height": 4,
    "feed_gender": "female",
    "sort_order": 3,
    "approval_certificate": null,
    "product_description": [
        {
            "name"  : "Produto Teste API",
            "description":"As descrições dos produtos para e-commerce deles incluem vários detalhes,técnicos.",
            "description_resume": "",
            "tag": "abc1234,teste33,444532"
        }
    ],
    "product_special":[
        {
            "priority": 0,
            "price"   : "100,00",
            "quantity": 1
            "date_start":"30-01-2017 10:49:32",
            "date_end":"30-05-2017 10:49:32"
        },
        {
            "priority": 1,
            "price"   : "60,00",
            "date_start":"30-05-2019 10:49:32",
            "date_end":"30-05-2032 10:49:32"
        }
    ],
    "product_image": [
        {
            "url": "https://img.irroba.com.br/irroba/cancun.jpg",
            "main_image": true,
            "sort_order": 0
        },
        {
            "base_64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
            "main_image": false,
            "sort_order": 1
        }
    ],
    "product_like":[
        {
            "model":"Irroba"
        },
        {
            "like_id":"17"
        }
    ],
    "product_to_category": [
        {
            "category_id": 5
        }
    ],
    "price_b2w": "1.500,00",
    "special_price_b2w": "1.500,00",
    "price_carrefour": "1.500,00",
    "special_price_carrefour": "1.500,00",
    "price_centauro": "1.500,00",
    "special_price_centauro": "1.500,00",
    "price_dafiti": "1.500,00",
    "special_price_dafiti": "1.500,00",
    "start_date_special_dafiti": "2021-08-27",
    "end_date_special_dafiti": "2021-09-27",
    "price_magazine": "1.500,00",
    "special_price_magazine": "1.500,00",
    "price_mercadolivre": "1.500,00",
    "price_shopee": "1.500,00",
    "price_netshoes": "1.500,00",
    "special_price_netshoes": "1.500,00",
    "price_viavarejo": "1.500,00",
    "special_price_viavarejo": "1.500,00"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Product updated successfully!",
        "product_id": 10172
    }
}

/product/{model}/model

Método responsável por alterar um produto utilizando como parâmetro o campo model.

Deverá ser realizado uma requisição PUT com o request necessário.

PUT https://api.irroba.com.br/v1/product/{{model}}/model

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do produto	Objeto em JSON
data model	Código do Produto	String Máximo de 120 caracteres
data external_reference	Referência externa do seu produto	String Máximo de 100 caracteres
data sku	Sku (Código de Barras de 8 - 13 Dígitos)	String Máximo de 120 caracteres
data price	Preço do Produto	String
data status	Status do Produto (1 Habilitado 0 Desabilitado)	Numérico (int)
data minimum	Quantidade mínima de compra. Se a quantidade mínima de compra for menor que a múltipla, o mínimo será salvo igual ao valor do múltiplo	String
data multiple_sales_quantity	Quantidade múltipla de compra. Se a quantidade mínima de compra for menor que a múltipla, o mínimo será salvo igual ao valor do múltiplo	String
data manufacturer_id	Id da Marca do produto, Buscar Ids das Marcas cadastradas na loja Marcas	Numérico (int)
data manufacturer	Json com as informações da marca do produto (enviar somente quando o manufacturer_id não existir) / Opção valida se existe alguma marca com esse nome, caso exista vincula a mesma ao produto, caso contrario cria uma nova marca e vincula ao produto.	JSON
data manufacturer name	Nome do Fabricante	String
data manufacturer sort_order	Ordenação com relação a outros fabricantes (do menor para o maior)	Numérico(int)
data price_attacked	Preço de atacado do produto	String
data cost_price	Preço de custo do produto	String
data weight	Peso do Produto	Numérico (float)
data length	Comprimento	Numérico (float)
data width	Largura	Numérico (float)
data height	Altura	Numérico (float)
data feed_gender	Gênero do produto que sera enviado para o google (male,female,unisex)	Numérico (float)
data sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data approval_certificate	Certificado de aprovação para produtos de EPI	String
data product_description	Json com informações da descrição do produto	JSON
data product_description name	Nome do Produto	String / Máximo de 300 caracteres
data product_description description	Descrição do Produto	String / Máximo de 2500 caracteres
data product_description description_resume	Descrição resumida do Produto	String
data product_description tag	Tags do produto (devem ser separadas por virgula)	String
data product_image	Json com informações das imagens do produto (Todas as outras imagens cadastrada neste produto serão deletadas quando este campo é enviado)	JSON
data product_image url	URL da imagem (Deve ser enviada somente uma das opções url ou base64)	String
data product_image base_64	BASE64 da imagem (Deve ser enviada somente uma das opções url ou base64)	String
data product_image main_image	Define se é a imagem principal do produto (True ou False)	Bool
data product_image sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data product_special	Json com informações das promoções do produto (Todas as outras promoções cadastrada neste produto serão deletadas quando este campo é enviado)	JSON
data product_special priority	Prioridade da promoção, caso ocorra conflito com outras a com menor valor será priorizadao	Numérico (int)
data product_special price	Preço para o produto. (Este campo só é considerado caso o price_type NÃO seja "discount")	Numérico (float)
data product_special price_type	Tipo de desconto, para "porcentagem enviar discount", "preço fixo enviar fixed". (Caso não enviado o campo por padrão o valor é fixed)	String
data product_special discount	Valor de desconto para a promoção, "Ex: 10.00 para o desconto de 10%".(Este campo somente é considerado caso o price_type seja "discount")	Numérico (float)
data product_special date_start	Data de início da promoção	String
data product_special date_end	Data final da promoção	String
data product_special customer_group_id	ID do grupo de usuários que poderá utilizar dessa promoção ("8" é o valor para o grupo de usuários Default)	String
data product_like	Json com informações das categorias de produtos semelhantes (Todas os outros produtos semelhantes neste produto serão deletadas quando este campo é enviado)	JSON
data product_like like_id	Id dos produtos semelhantes, Os Ids podem ser consultados no seguinte método Produtos (Deve ser enviada somente uma das opções like_id ou model)	Numérico (int)
data product_like model	Model do Produto (Deve ser enviada somente uma das opções like_id ou model)	String
data product_to_category	Json com informações das categorias do produto (Todas as outras categorias vinculadas neste produto serão removidas quando este campo é enviado)	JSON
data product_to_category category_id	Id da categoria, Os Ids podem ser consultados no seguinte método Categorias (Deve ser enviada somente uma das opções category_id ou reference)	Numérico (int)
data product_to_category reference	Referência da categoria (Deve ser enviada somente uma das opções category_id ou reference)	String
data product_attribute	Json com os atributos do produto	JSON
data product_attribute group	Nome do grupo de atributos	String
data product_attribute attribute	Nome do atributo	String
data product_attribute text	Texto de informações sobre o atributo	String
data product_attribute enable_view	Informa se o atributo sera exibido no front (true para não exibir no front)	Bool
price_b2w	Preço para a B2W	String
special_price_b2w	Preço promocional para a B2W	String
price_carrefour	Preço para o Carrefour	String
special_price_carrefour	Preço promocional para o Carrefour	String
price_centauro	Preço para a Centauro	String
special_price_centauro	Preço promocional para a Centauro	String
price_dafiti	Preço para a Dafiti	String
special_price_dafiti	Preço promocional para a Dafiti	String
start_date_special_dafiti	Data de início da promoção	String / Obrigatório caso envie o preço promocional
end_date_special_dafiti	Data do fim da promoção	String / Obrigatório caso envie o preço promocional
price_magazine	Preço para o Magazine	String
special_price_magazine	Preço promocional para o Magazine	String
price_mercadolivre	Preço para o Mercado Livre	String
price_shopee	Preço para a Shopee	Numérico (float)
price_netshoes	Preço para a Netshoes	String
special_price_netshoes	Preço promocional para a Netshoes	String
price_viavarejo	Preço para a Via Varejo	String
special_price_viavarejo	Preço promocional para a Via Varejo	String

{
    "model" : "ABC12345",
    "sku" : "12344477886",
    "price" : "1.200,00",
    "status": 1,
    "minimum": 1,
    "multiple_sales_quantity": 1,
    "manufacturer_id": 33,
    "manufacturer": { //Caso manufacturer_id seja enviado o JSON manufacturer sera desconsiderado
		"name" : "Marca teste",
		"sort_order": 1
	},
    "price_attacked": "300,00",
    "cost_price": "220,00",
    "weight": 4,
    "length": 3,
    "width": 6,
    "height": 4,
    "feed_gender": "female",
    "sort_order": 3,
    "approval_certificate": null,
    "product_description": [
        {
            "name"  : "Produto Teste API",
            "description":"As descrições dos produtos para e-commerce deles incluem vários detalhes,técnicos.",
            "description_resume": "",
            "tag": "abc1234,teste33,444532"
        }
    ],
    "product_special":[
        {
            "priority": 0,
            "price"   : "100,00",
            "date_start":"30-01-2017 10:49:32",
            "date_end":"30-05-2017 10:49:32"
        },
        {
            "priority": 1,
            "price"   : "60,00",
            "date_start":"30-05-2019 10:49:32",
            "date_end":"30-05-2032 10:49:32"
        }
    ],
    "product_image": [
        {
            "url": "https://img.irroba.com.br/irroba/cancun.jpg",
            "main_image": true,
            "sort_order": 0
        },
        {
            "base_64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD...",
            "main_image": false,
            "sort_order": 1
        }
    ],
    "product_like":[
        {
            "model":"Irroba"
        },
        {
            "like_id":"17"
        }
    ],
    "product_to_category": [
        {
            "category_id": 5
        }
    ],
    "price_b2w": "1.500,00",
    "special_price_b2w": "1.500,00",
    "price_carrefour": "1.500,00",
    "special_price_carrefour": "1.500,00",
    "price_centauro": "1.500,00",
    "special_price_centauro": "1.500,00",
    "price_dafiti": "1.500,00",
    "special_price_dafiti": "1.500,00",
    "start_date_special_dafiti": "2021-08-27",
    "end_date_special_dafiti": "2021-09-27",
    "price_magazine": "1.500,00",
    "special_price_magazine": "1.500,00",
    "price_mercadolivre": "1.500,00",
    "price_shopee": "1.500,00",
    "price_netshoes": "1.500,00",
    "special_price_netshoes": "1.500,00",
    "price_viavarejo": "1.500,00",
    "special_price_viavarejo": "1.500,00"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": {
        "Message": "Product updated successfully!",
        "product_id": 10172
    }
}

/product/{{id}}/stock

Método responsável por atualizar as opções de estoques do produto através do product_id.

Observação:Caso o parâmetro seja model, recomendamos que faça uso da rota /product/{model}/model/stock.

Deverá ser realizado uma requisição PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/product/{{id}} ou {{model}}/stock

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do estoque do produto	Objeto em JSON
data option_id	ID da opção, Conforme as opções disponiveis Opções	Numérico (int) / Obrigatório
data required	Se a opção é obrigatória ou não (True ou False)	bool
data principal	Se a opção é principal do produto ou não (True ou False)	bool
data grid_stock	Se a opção é em grade ou não(True ou False)	bool
data product_option_value	Json com informações das variações do produto	Json
data product_option_value option_value_id	Id da variação, Conforme as opções disponiveis Opções	Json
data product_option_value quantity	Quantidade em estoque da variação (Enviando o estoque negativo será automaticamente considerado como zero)	Numérico (int)
data product_option_value reference	Referência da opção de estoque (Utilizada para atualização de quantidades)	String
data product_option_value price	Preço da opção de estoque (Preencher este campo somente quando a variação de estoque possuir preço diferente do produto)	String
data product_option_value external_reference	Referência externa utilizado para inserir o ID da opção de estoque em seu ERP	String
data product_option_value subtract	Informa se a variação controla estoque (True ou False)	bool
data product_option_value stock_type	Ação do estoque com a quantidade zerada, você pode verificar as ações disponiveis na seguinte Tabela (Caso não enviado por padrão a opção será o Avise-me "warn_me")	String
data product_option_value consider_orders	Informar este parametro como true, caso deseje desconsiderar pedidos aguardando pagamento (Somente ira funcionar caso as opções de estoques enviadas no JSON ja exista no produto).	String

{
    "options": [
        {
            "option_id": 29,
            "principal": true,
            "required": true,
            "grid_stock": false,
            "product_option_value": [{
                "option_value_id": 255,
                "quantity": 50,
                "reference": "",
                "price": "100,00",
                "subtract" : true,
            }],
        },
        {
            "option_id": 78,
            "principal": true,
            "product_option_value": [{
                "option_value_id": 123,
                "quantity": 50,
                "reference": "",
                "external_reference": "ABC-1234"
            }],
            "required": true
        }
    ]
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Stock options for this product have been updated!"
}

/product/{{model}}/model/stock

Método responsável por atualizar as opções de estoques do produto através do campo model.

Deverá ser realizado uma requisição PUT com o request necessário e informando o model do mesmo.

PUT https://api.irroba.com.br/v1/product/{{model}}/model/stock

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do estoque do produto	Objeto em JSON
data option_id	ID da opção, Conforme as opções disponiveis Opções	Numérico (int) / Obrigatório
data required	Se a opção é obrigatória ou não (True ou False)	bool
data principal	Se a opção é principal do produto ou não (True ou False)	bool
data grid_stock	Se a opção é em grade ou não(True ou False)	bool
data product_option_value	Json com informações das variações do produto	Json
data product_option_value option_value_id	Id da variação, Conforme as opções disponiveis Opções	Json
data product_option_value quantity	Quantidade em estoque da variação (Enviando o estoque negativo será automaticamente considerado como zero)	Numérico (int)
data product_option_value reference	Referência da opção de estoque (Utilizada para atualização de quantidades)	String
data product_option_value price	Preço da opção de estoque (Preencher este campo somente quando a variação de estoque possuir preço diferente do produto)	String
data product_option_value external_reference	Referência externa utilizado para inserir o ID da opção de estoque em seu ERP	String
data product_option_value subtract	Informa se a variação controla estoque (True ou False)	bool
data product_option_value stock_type	Ação do estoque com a quantidade zerada, você pode verificar as ações disponiveis na seguinte Tabela (Caso não enviado por padrão a opção será o Avise-me "warn_me")	String
data product_option_value consider_orders	Informar este parametro como true, caso deseje desconsiderar pedidos aguardando pagamento (Somente ira funcionar caso as opções de estoques enviadas no JSON ja exista no produto).	String
data preserve_missing	Na atualização das opções de estoques do produto, a configuração preserve_missing determina se as variações não enviadas serão mantidas (true) ou removidas (false)	bool

{
    "options": [
        {
            "option_id": 29,
            "principal": true,
            "required": true,
            "grid_stock": false,
            "product_option_value": [{
                "option_value_id": 255,
                "quantity": 50,
                "reference": "",
                "price": "100,00",
                "subtract" : true,
            }],
        },
        {
            "option_id": 78,
            "principal": true,
            "product_option_value": [{
                "option_value_id": 123,
                "quantity": 50,
                "reference": "",
                "external_reference": "ABC-1234"
            }],
            "required": true
        }
    ],
    "preserve_missing": false
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

/product/stock/{{id}}

Método responsável por atualizar um valor de estoque através do product_option_value_id.

Deverá ser realizado uma requisição PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/product/stock/{{id}}

Requisição

Nome	Descrição	Formato
quantity	Quantidade de estoque desejada	Numérico (int) / Obrigatório
external_reference	Referência externa utilizado para inserir o ID da opção de estoque em seu ERP	String

{
    "quantity": 1,
    "external_reference": "abc1234"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Stock updated successfully!"
}

/product/stock/reference/{{reference}}

Método responsável por atualizar um valor de estoque através da referência.

Deverá ser realizado uma requisição PUT com o request necessário e informando a Reference do mesmo.

Observação:Será subtraído do valor enviado no payload a quantidade que se encontra em pedidos aguardando pagamento e que tenham a variação em questão.

PUT https://api.irroba.com.br/v1/product/stock/reference/{{reference}} ou {{external_reference}}

Requisição

Nome	Descrição	Formato
quantity	Quantidade de estoque desejada	Numérico (int) / Obrigatório

{
    "quantity": 1,
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String
product_id	Identificação do produto afetado	Numérico (int)

{
    "success": "true",
    "data": "Stock updated successfully!",
    "product_id": "1234"
}

/product/stock/batch

Método responsável por atualizar um valor de estoque em massa através da referência ou external_reference.

Observação: O Método possui uma limitação de atualizar 100 referências por requisição

Deverá ser realizado uma requisição PUT com o request necessário e informando a Reference do mesmo.

Será subtraído do valor enviado no payload a quantidade que se encontra em pedidos aguardando pagamento e que tenham a variação em questão.

PUT https://api.irroba.com.br/v1/product/stock/batch

Requisição

Nome	Descrição	Formato
quantity	Quantidade de estoque desejada	Numérico (int) / Obrigatório
reference ou external_reference	Referência ou external_reference do estoque que deseja alterar	String / Obrigatório
consider_orders	Informar este parametro caso deseje desconsiderar pedidos aguardando pagamento	bool

[
    {
        "reference": "ab12",
        "quantity": 30,
        "consider_orders" : true
    },
    {
        "external_reference": "ab123",
        "quantity": 22
    },
    {
        "reference": "ab1234",
        "quantity": 12
    }
]

Resposta

Caso não ocorra nenhum problema, o método irá retornar o error como true.

Caso contrário, irá retornar error como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String
info	Informações dos produto afetado	JSON

{
    "success": "true",
    "data": "Stock updated successfully!",
    "info": [
        {
            "error": false,
            "external_reference/reference": "ab12",
            "message": "Stock updated successfully!"
        },
        {
            "error": true,
            "external_reference/reference": "ab123",
            "message": "Product doest not exist!"
        }
    ]
}

/product/{{product_id}}/price

Método responsável por atualizar o preço de um produto através do product_id.

Observação: Caso o parâmetro seja model, recomendamos que faça uso da rota /product/{model}/model/price.

Deverá ser realizado uma requisição PUT com o request necessário e informando o ID do mesmo.

PUT https://api.irroba.com.br/v1/product/{{id}} ou {{model}}/price

Requisição

Nome	Descrição	Formato
price	Preço desejado	Numérico (float) / Obrigatório
cost	Custo desejado	Numérico (float)
price_b2w	Preço para a B2W	Numérico (float)
special_price_b2w	Preço promocional para a B2W	Numérico (float)
price_carrefour	Preço para o Carrefour	Numérico (float)
special_price_carrefour	Preço promocional para o Carrefour	Numérico (float)
price_centauro	Preço para a Centauro	Numérico (float)
special_price_centauro	Preço promocional para a Centauro	Numérico (float)
price_dafiti	Preço para a Dafiti	Numérico (float)
special_price_dafiti	Preço promocional para a Dafiti	Numérico (float)
start_date_special_dafiti	Data de início da promoção	String / Obrigatório caso envie o preço promocional
end_date_special_dafiti	Data do fim da promoção	String / Obrigatório caso envie o preço promocional
price_magazine	Preço para o Magazine	Numérico (float)
special_price_magazine	Preço promocional para o Magazine	Numérico (float)
price_mercadolivre	Preço para o Mercado Livre	Numérico (float)
price_shopee	Preço para a Shopee	Numérico (float)
price_netshoes	Preço para a Netshoes	Numérico (float)
special_price_netshoes	Preço promocional para a Netshoes	Numérico (float)
price_viavarejo	Preço para a Via Varejo	Numérico (float)
special_price_viavarejo	Preço promocional para a Via Varejo	Numérico (float)
field	Campo que deseja encontrar o produto (model ou product_id). O sistema busca o produto somente pelo campo enviado. Caso não enviar a mesma o sistema busca primeiro pelo model caso não encontre o produto ele busca pelo product_id	String

{
    "price": 10.00,
    "cost": 5.00,
    "price_b2w": 15.00,
    "special_price_b2w": 15.00,
    "price_carrefour": 15.00,
    "special_price_carrefour": 15.00,
    "price_centauro": 15.00,
    "special_price_centauro": 15.00,
    "price_dafiti": 15.00,
    "special_price_dafiti": 15.00,
    "start_date_special_dafiti": "2021-08-27",
    "end_date_special_dafiti": "2021-09-27",
    "price_magazine": 15.00,
    "special_price_magazine": 15.00,
    "price_mercadolivre": 15.00,
    "price_shopee": 15.00,
    "price_netshoes": 15.00,
    "special_price_netshoes": 15.00,
    "price_viavarejo": 15.00,
    "special_price_viavarejo": 15.00,
    "field": "model"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Price updated successfully!"
}

/product/{{model}}/model/price

Método responsável por atualizar o preço de um produto através do campo model.

Deverá ser realizado uma requisição PUT com o request necessário e informando o model do mesmo.

PUT https://api.irroba.com.br/v1/product/{{model}}/model/price

Requisição

Nome	Descrição	Formato
price	Preço desejado	Numérico (float) / Obrigatório
cost	Custo desejado	Numérico (float)
price_b2w	Preço para a B2W	Numérico (float)
special_price_b2w	Preço promocional para a B2W	Numérico (float)
price_carrefour	Preço para o Carrefour	Numérico (float)
special_price_carrefour	Preço promocional para o Carrefour	Numérico (float)
price_centauro	Preço para a Centauro	Numérico (float)
special_price_centauro	Preço promocional para a Centauro	Numérico (float)
price_dafiti	Preço para a Dafiti	Numérico (float)
special_price_dafiti	Preço promocional para a Dafiti	Numérico (float)
start_date_special_dafiti	Data de início da promoção	String / Obrigatório caso envie o preço promocional
end_date_special_dafiti	Data do fim da promoção	String / Obrigatório caso envie o preço promocional
price_magazine	Preço para o Magazine	Numérico (float)
special_price_magazine	Preço promocional para o Magazine	Numérico (float)
price_mercadolivre	Preço para o Mercado Livre	Numérico (float)
price_shopee	Preço para a Shopee	Numérico (float)
price_netshoes	Preço para a Netshoes	Numérico (float)
special_price_netshoes	Preço promocional para a Netshoes	Numérico (float)
price_viavarejo	Preço para a Via Varejo	Numérico (float)
special_price_viavarejo	Preço promocional para a Via Varejo	Numérico (float)
field	Campo que deseja encontrar o produto (model ou product_id). O sistema busca o produto somente pelo campo enviado. Caso não enviar a mesma o sistema busca primeiro pelo model caso não encontre o produto ele busca pelo product_id	String

{
    "price": 10.00,
    "cost": 5.00,
    "price_b2w": 15.00,
    "special_price_b2w": 15.00,
    "price_carrefour": 15.00,
    "special_price_carrefour": 15.00,
    "price_centauro": 15.00,
    "special_price_centauro": 15.00,
    "price_dafiti": 15.00,
    "special_price_dafiti": 15.00,
    "start_date_special_dafiti": "2021-08-27",
    "end_date_special_dafiti": "2021-09-27",
    "price_magazine": 15.00,
    "special_price_magazine": 15.00,
    "price_mercadolivre": 15.00,
    "price_shopee": 15.00,
    "price_netshoes": 15.00,
    "special_price_netshoes": 15.00,
    "price_viavarejo": 15.00,
    "special_price_viavarejo": 15.00,
    "field": "model"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Price updated successfully!"
}

/product/{{id}}

Método responsável por deletar um Produto.

Observação: Caso o parâmetro seja model, recomendamos que faça uso da rota /product/{model}.

Deverá ser realizado uma requisição DELETE informando o ID do mesmo.

DELETE https://api.irroba.com.br/v1/product/{{id}}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Product deleted successfully!"
}

/product/{{model}}

Método responsável por deletar um Produto.

Deverá ser realizado uma requisição DELETE informando o campo model do mesmo.

DELETE https://api.irroba.com.br/v1/product/{{model}}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Product deleted successfully!"
}

Order (Pedidos)

Tabela de possíveis ordenações

A baixo todos os filtros disponíveis para métodos que são listas de pedidos. Para utilizar basta através da URL informar o parâmetro sort. E através do parâmetro order informar o tipo de ordenação (ASC ou DESC). Caso os valores informados estejam incorretos, por padrão os valores são date_added e DESC respectivamente.

Nome	Descrição
order_id	ID do pedido
marketplace_order_id	ID do pedido dentro do Marketplace
marketplace	Nome do Marketplace
customer_id	ID do cliente
customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)
return_id	ID do pedido de troca
type_person	Indica se é pssoa física (F) ou pessoa jurídica (J)
firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)
email	Email do cliente comprador
telephone	Telefone do cliente, pode haver ou não formatação
cellphone	Celular do cliente, pode haver ou não formatação
cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação
rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação
payment_firstname	Nome do cliente responsável pelo pagamento
payment_address_1	Endereço do cliente responsável pelo pagamento
payment_number_home	Número (endereço) do cliente responsável pelo pagamento
payment_neighborhood	Bairro do cliente responsável pelo pagamento
payment_address_2	Complemento do endereço do cliente responsável pelo pagamento
payment_city	Cidade do cliente responsável pelo pagamento
payment_postcode	CEP do cliente responsável pelo pagamento
payment_country	País do cliente responsável pelo pagamento
payment_zone	Estado do cliente responsável pelo pagamento
payment_code	Código da Forma de pagamento do pedido (Para de fato identificar uma forma de pagamento)
shipping_firstname	Nome do cliente que irá receber o pedido
shipping_address_1	Endereço do cliente que irá receber o pedido
shipping_number_home	Número (endereço) do cliente que irá receber o pedido
shipping_neighborhood	Bairro do cliente que irá receber o pedido
shipping_address_2	Complemento do endereço do cliente que irá receber o pedido
shipping_city	Cidade do cliente que irá receber o pedido
shipping_postcode	CEP do cliente que irá receber o pedido
shipping_country	País do cliente que irá receber o pedido
shipping_zone	Estado do cliente que irá receber o pedido
comment	Comentário realizado pelo cliente no pedido
total	Valor total da compra
tracking	Código de rastreio do pedido (caso já tenha sido enviado)
order_status_id	ID do status atual do pedido
date_added	Data que o cliente foi adicionado (Padrão ISO 8601)
date_modified	Data que o cliente foi modificado (Padrão ISO 8601)
user_log	Usuário responsável pela atualização

Order (Pedidos)

Utilize os sufixos

A baixo todos os sufixos disponíveis para filtrar as listas de pedidos. Para utilizar basta através da URL informar o parâmetro da tabela a baixo.

Sufixo	Objetivo
\|contains	Campo que contém um determinado valor
\|greater	Data (ou número) maiores que o valor especificado
\|lesser	Data (ou número) menores que o valor especificado
\|in	Utilizado para se passar uma lista de valores (separados por virgula)

Utilize pipe "|" como separador do sufixo com o nome do atributo

Exemplos:
/order?order_status_id|in=7,3
/order?order_status_id|in=7,3&payment_code|contains=pagseguro_billet

Tabela de status

obs.: alguns status podem ser alterados pelo cliente.

ID	Nome
3	Pedido em Transporte
5	Pagamento Aprovado
7	Pedido Cancelado
17	Aguardando Pagamento
20	Pedido Entregue
21	Pedido Negado
22	Pagamento em Análise
23	Emissão de Nota Fiscal
24	Substituição/Análise Solicitada
25	Merc. para Substituição Recebida
26	Aguardando Merc. a ser Substituída
27	Preparando para Envio
28	Em produção
29	Aguardando Retirada na Loja
30	Pedido Devolvido
31	Merc. Perdida Fluxo Postal
32	Merc. Em processamento
33	Enviar agregado a outro pedido
34	Aguardando Retirada

Tabela de Métodos de Envio

shipping_method	Nome
braspress	BrassPress
braspress_api	BrassPress API
clique_retire_correios	Clique e Retire - Correios
data_frete	Data Frete
fixed	Valor Fixo
frenet	Frenet
gfl	GFL
gollog	Gollog
jadlog_api	JadLog API
kangu	Kangu
letter	Carta Registrada - Correios
mandae	Mandaê
melhor_envio	MelhorEnvio
motoboy	Motoboy
pac	PAC - Correios
sedex	SEDEX - Correios
rede_sul	Rede Sul
rodonaves	Rodonaves
sedexdez	SEDEX DEZ - Correios
shipping_company	Transportadora
shipping_custom	Frete Personalizado
shipping_official	Transportadora Oficial
smart_envios	SmartEnvios
tnt_mercurio	TNT Mercúrio
total_express	Total Express
transfolha	Premici Envios / Transfolha

/order

Método responsável por retornar uma lista com informações básicas dos pedidos. Além de retornar algumas informações do pedido, retornará também todos os status do mesmo, sendo o último o status atual. Deverá ser realizado uma requisição GET.

1 - Há a possibilidade de ordenar os dados de acordo com a tabela.

2 - Há a possibilidade de filtrar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/order

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os pedidos retornados	Objeto em JSON
data order_id	ID do pedido	String
data is_mirrored	Indica se o pedido é espelhado ou não	bool
data firstname	Nome do cliente comprador	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data number_parcel	Quantidade de parcelas	Numérico (int)
data total	Valor total do pedido	Numérico (float)
data external_reference	Referência externa utilizado para inserir o ID do pedido em seu ERP	String
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data customer_group_name	Nome do grupo de usuários do cliente	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history name order_status_id	ID do status (Único)	Numérico (int)
data order_history name name	Nome do status	String
data Interest	Valor dos juros aplicado no pedido	Numérico (float)
data intermediary_name	Nome do intermediador do pagamento	String
data intermediary_cnpj	CNPJ do intermediador do pagamento	String
data intermediary_operation_name	Nome do intermediador da operação	String
data intermediary_operation_cnpj	CNPJ do intermediador da operação	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/order?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
    {
      "order_id": 9115,
      "firstname": "John Doe",
      "date_added": "2017-05-05 09:10:32",
      "total": "168.5720",
      "customer_group_id": 8,
      "customer_group_name": "Default",
      "payment_method": "Visa",
      "number_parcel": 4,
      "is_mirrored": false,
      "order_history": [
        {
          "order_history_id": 3733566,
          "order_status_id": 5,
          "notify": 1,
          "comment": "Pagamento Aprovado",
          "user_log": "paypal",
          "date_added": "2017-05-05 09:10:55",
          "name": {
            "order_status_id": 5,
            "name": "Pagamento Aprovado"
          }
        },
        {
          "order_history_id": 3733565,
          "order_status_id": 17,
          "notify": 0,
          "comment": "",
          "user_log": "lojista",
          "date_added": "2017-05-05 09:10:33",
          "name": {
            "order_status_id": 17,
            "name": "Aguardando Pagamento"
          }
        }
      ],
      "interest": 16.33
      "intermediary_name": "Pagar.me",
      "intermediary_cnpj": "18727053000174"
      "intermediary_operation_cnpj": "13743978000195",
      "intermediary_operation_name": "Intermediador de teste"
    }
    ...
  ]
}

/order/status/{{id}}

Método responsável por retornar uma lista com informações básicas dos pedidos filtrando por um status específico. Além de retornar algumas informações do pedido, retornará também todos os status do mesmo, sendo o último o status atual. Deverá ser realizado uma requisição GET.

Você pode utilizar a tabela de status para conhecer os possíveis "Status".

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/order/status/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
pagination total	Quantidade total de registros por status	Numérico (int)
data	Objeto com todos os pedidos retornados	Objeto em JSON
data order_id	ID do pedido	Numérico (int)
data firstname	Nome do cliente comprador	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data total	Valor total do pedido	Numérico (float)
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data customer_group_name	Nome do grupo de usuários do cliente	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history name order_status_id	ID do status (Único)	Numérico (int)
data order_history name name	Nome do status	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/order?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2,
    "total": 1,
  },
  "data": [
    {
      "order_id": 9115,
      "firstname": "John Doe",
      "date_added": "2017-05-05 09:10:32",
      "total": "168.5720",
      "customer_group_id": 8,
      "customer_group_name": "Default",
      "order_history": [
        {
          "order_history_id": 3733566,
          "order_status_id": 5,
          "notify": 1,
          "comment": "Pagamento Aprovado",
          "user_log": "paypal",
          "date_added": "2017-05-05 09:10:55",
          "name": {
            "order_status_id": 5,
            "name": "Pagamento Aprovado"
          }
        },
        {
          "order_history_id": 3733565,
          "order_status_id": 17,
          "notify": 0,
          "comment": "",
          "user_log": "lojista",
          "date_added": "2017-05-05 09:10:33",
          "name": {
            "order_status_id": 17,
            "name": "Aguardando Pagamento"
          }
        }
      ]
    }
    ...
  ]
}

/order/added/{{date}}

Método responsável por retornar uma lista com informações básicas dos pedidos filtrando por uma data inicial. Além de retornar algumas informações do pedido, retornará também todos os status do mesmo, sendo o último o status atual. Deverá ser realizado uma requisição GET.

A data deverá ser informada no seguinte padrão YYYY-MM-DD, onde seria ano com quatro dígitos, mês com dois dígitos, e dia com dois dígitos

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/order/added/{{date}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os pedidos retornados	Objeto em JSON
data order_id	ID do pedido	Numérico (int)
data firstname	Nome do cliente comprador	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data total	Valor total do pedido	Numérico (float)
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data customer_group_name	Nome do grupo de usuários do cliente	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history name order_status_id	ID do status (Único)	Numérico (int)
data order_history name name	Nome do status	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/order?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
    {
      "order_id": 9115,
      "firstname": "John Doe",
      "date_added": "2017-05-05 09:10:32",
      "total": "168.5720",
      "customer_group_id": 8,
      "customer_group_name": "Default",
      "order_history": [
        {
          "order_history_id": 3733566,
          "order_status_id": 5,
          "notify": 1,
          "comment": "Pagamento Aprovado",
          "user_log": "paypal",
          "date_added": "2017-05-05 09:10:55",
          "name": {
            "order_status_id": 5,
            "name": "Pagamento Aprovado"
          }
        },
        {
          "order_history_id": 3733565,
          "order_status_id": 17,
          "notify": 0,
          "comment": "",
          "user_log": "lojista",
          "date_added": "2017-05-05 09:10:33",
          "name": {
            "order_status_id": 17,
            "name": "Aguardando Pagamento"
          }
        }
      ]
    }
    ...
  ]
}

/order/added/{{date_ini}}/{{date_end}}

Método responsável por retornar uma lista com informações básicas dos pedidos filtrando por um periodo de datas. Além de retornar algumas informações do pedido, retornará também todos os status do mesmo, sendo o último o status atual. Deverá ser realizado uma requisição GET.

A data deverá ser informada no seguinte padrão YYYY-MM-DD, onde seria ano com quatro dígitos, mês com dois dígitos, e dia com dois dígitos

Há a possibilidade de ordenar os dados de acordo com a tabela.

Parâmetro opcional, informar "history=true" para filtrar através do periodo de histórico adicionados nos pedidos

GET https://api.irroba.com.br/v1/order/added/{{date_ini}}/{{date_end}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os pedidos retornados	Objeto em JSON
data order_id	ID do pedido	Numérico (int)
data firstname	Nome do cliente comprador	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data total	Valor total do pedido	Numérico (float)
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data customer_group_name	Nome do grupo de usuários do cliente	String
data payment_method	Método de pagamento utilizado	String
data number_parcel	Quantidade de parcelas	Numérico (int)
data external_reference	Referência externa utilizado para inserir o ID do pedido em seu ERP	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history name order_status_id	ID do status (Único)	Numérico (int)
data order_history name name	Nome do status	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/order?page=1&limit=2&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
    {
      "order_id": 9115,
      "firstname": "John Doe",
      "date_added": "2017-05-05 09:10:32",
      "total": "168.5720",
      "customer_group_id": 8,
      "customer_group_name": "Default",
      "payment_method": "Visa",
      "number_parcel": 4,
      "order_history": [
        {
          "order_history_id": 3733566,
          "order_status_id": 5,
          "notify": 1,
          "comment": "Pagamento Aprovado",
          "user_log": "paypal",
          "date_added": "2017-05-05 09:10:55",
          "name": {
            "order_status_id": 5,
            "name": "Pagamento Aprovado"
          }
        },
        {
          "order_history_id": 3733565,
          "order_status_id": 17,
          "notify": 0,
          "comment": "",
          "user_log": "lojista",
          "date_added": "2017-05-05 09:10:33",
          "name": {
            "order_status_id": 17,
            "name": "Aguardando Pagamento"
          }
        }
      ]
    }
    ...
  ]
}

/order/details

Método responsável por retornar uma lista com todas informações dos Pedidos. Além disso, retornará também:

- Dados dos produtos.

- Totais (Sub-total, forma de envio, descontos e etc).

- Lista de Status do pedido, sendo o último o status atual.

Há a possibilidade de ordenar os dados de acordo com a tabela.

Há a possibilidade de filtrar os dados de acordo com a tabela.

Deverá ser realizado uma requisição GET.

GET https://api.irroba.com.br/v1/order/details

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
pagination total	Total de pedidos	Numérico (int)
data	Objeto com todos os pedidos retornados	Objeto em JSON
data order_id	ID do pedido	Numérico (int)
data marketplace_order_id	ID do pedido dentro do Marketplace	string
data marketplace	Nome do Marketplace	string
data store_url	URL da loja	String
data customer_id	ID do cliente	Numérico (int)
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data return_id	ID do pedido de troca	Numérico (int)
data nsu	NSU (Número Sequencial único) gerado apenas pelo método de pagamento Rede Card. Retorna false caso venha vazio	String
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador	String
data lastname	Sobrenome do cliente comprador	String
data email	Email do cliente comprador	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data payment_firstname	Nome do cliente responsável pelo pagamento	String
data payment_address_1	Endereço do cliente responsável pelo pagamento	String
data payment_number_home	Número (endereço) do cliente responsável pelo pagamento	String
data payment_neighborhood	Bairro do cliente responsável pelo pagamento	String
data payment_address_2	Complemento do endereço do cliente responsável pelo pagamento	String
data payment_city	Cidade do cliente responsável pelo pagamento	String
data payment_postcode	CEP do cliente responsável pelo pagamento	String
data payment_country	País do cliente responsável pelo pagamento	String
data payment_zone	Estado do cliente responsável pelo pagamento	String
data payment_zone_id	ID do estado, conferir tabela de estados	Numérico (int)
data payment_method	Forma de pagamento do pedido (Não deve ser utilizado como identificador, é somente um texto de exibição)	String
data payment_code	Código da Forma de pagamento do pedido (Para de fato identificar uma forma de pagamento)	String
data payment_condition	Condição de pagamento (Apenas para pagamento por faturamento)	String
data payment_details	Objeto que contém os detalhes do pagamento do pedido (Caso a forma de pagamento não retornem estas informações os campos desse JSON serão vazio).	Objeto em JSON
data payment_details NSU	NSU da transação	Numérico
data payment_details transaction_id	ID da transação	Numérico
data payment_details authorization_code	Código de autorização da transação	String
data payment_details billet_line	Linha digitável do boleto	String
data payment_details billet_our_number	Número do boleto no gateway de pagamento	String
data payment_details billet_due_date	Data de vencimento do boleto	String
data shipping_firstname	Nome do cliente que irá receber o pedido	String
data shipping_lastname	Sobrenome do cliente que irá receber o pedido	String
data shipping_address_1	Endereço do cliente que irá receber o pedido	String
data shipping_number_home	Número (endereço) do cliente que irá receber o pedido	String
data shipping_neighborhood	Bairro do cliente que irá receber o pedido	String
data shipping_address_2	Complemento do endereço do cliente que irá receber o pedido	String
data shipping_city	Cidade do cliente que irá receber o pedido	String
data shipping_postcode	CEP do cliente que irá receber o pedido	String
data shipping_country	País do cliente que irá receber o pedido	String
data shipping_zone	Estado do cliente que irá receber o pedido	String
data shipping_zone_id	ID do estado, conferir tabela de estados	Numérico (int)
data shipping_custom_field	Campo personalizável do endereço de entrega	String
data shipping_method	Método de envio, conferir tabela de métodos de envio	String
data shipping_code	Código da forma de envio (Para de fato identificar a forma de envio selecionada)	String
data shipping_delivery_time	Quantidade de dias previsto para a entrega do pedido	Numérico (int)
data comment	Comentário realizado pelo cliente no pedido	String
data melhor_envio_service	ID da forma de envio na Melhor envio. (Somente sera exibido caso a forma de envio do pedido for Melhor envio)	String
data smart_envios_service	ID da forma de envio na Smart Envios. (Somente sera exibido caso a forma de envio do pedido for Smart Envios).	String
data data_frete_id_table	ID da forma de envio na Data Frete. (Somente sera exibido caso a forma de envio do pedido for Data Frete).	String
data total	Valor total da compra	Numérico (float)
data order_status_id	ID do status atual do pedido	Numérico (int)
data tracking	Código de rastreio do pedido (caso já tenha sido enviado)	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data date_modified	Data e horário que o pedido foi alterado (Padrão ISO 8601)	String
data attacked_status	Identifica se o pedido foi finalizado em atacado	bool
data user_seller	Nome do vendedor responsável por esse pedido	String
data user_seller_id	ID do vendedor responsável por esse pedido	Numérico (int)
data customer_group_name	Nome do grupo de usuários do cliente	String
data external_reference	Referência externa utilizado para inserir o ID do pedido em seu ERP	String
data gift	Objeto que contém as informações do brinde do pedido	Objeto em JSON
data gift product_id	ID do produto	String
data gift name/model	Nome do produto - Nome da opção do produto	String
data gift sku	Model do produto	String
data gift price	Preço do brinde	String
data gift total	Preço total do brinde	String
data gift quantity	Quantidade do brinde	String
data intelipost_delivery_id	ID da forma de envio na Intelipost. (Somente sera exibido caso a forma de envio do pedido for Intelipost).	Numérico (int)
data cnpj_contact	Nome do contato para pessoa juridica	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history name order_status_id	ID do status (Único)	Numérico (int)
data order_history name name	Nome do status	String
data order_product	Objeto que contém todos os produtos do pedido	Objeto em JSON
data order_product order_product_id	ID do produto neste pedido específico	Numérico (int)
data order_product product_id	ID do produto	Numérico (int)
data order_product name	Nome do produto	String
data order_product model	Código do produto dentro do sistema (Modelo)	String
data order_product quantity	Quantidade adquirida no pedido	Numérico (int)
data order_product price	Preço do produto (no momento da compra)	Numérico (float)
data order_product price_attacked	Preço de atacado do produto (no momento da compra)	Numérico (float)
data order_product total	Preço total para esse produto (de acordo com a quantidade)	Numérico (float)
data order_product total_attacked	Preço total de atacado para esse produto (de acordo com a quantidade)	Numérico (float)
data order_product free_product_coupon	Sinaliza se o produto saiu de forma gratuita ou não, via cupom	bool
data order_product options	Objeto que contém informações das opções do produto comprado	Objeto em JSON
data order_product options order_option_id	ID da opção para este produto no pedido	Numérico (float)
data order_product options product_option_id	ID da opção dentro deste produto	Numérico (float)
data order_product options product_option_value_id	ID da opção "filha" dentro deste produto	Numérico (float)
data order_product options name	Nome da opção "pai"	String
data order_product options value	Nome da opção "filha"	String
data order_product options option_value	Objeto que contém informações das opções "filhas" selecionadas para essa opção	Objeto em JSON
data order_product options option_value option_value_id	ID da opção filha	Numérico (float)
data order_product options option_value quantity	Quantidade de estoque da opção	Numérico (int)
data order_product options option_value price	Preço da opção (acréscimo ou decréscimo de acordo com prefix_price)	Numérico (float)
data order_product options option_value price_prefix	Define se haverá acréscimo ou decréscimo no preço	String
data order_product options option_value weight	Peso da opção (acréscimo ou decréscimo de acordo com weight_price)	Numérico (float)
data order_product options option_value weight_prefix	Define se haverá acréscimo ou decréscimo no peso	String
data order_product options option_value reference	Referência da opção de estoque (Pode ser um código interno ou código de barras)	String
data order_product options option_value name	Nome da opção "filha"	String
data order_product dimensions	Objeto que contém informações das opções do produto comprado	Objeto em JSON
data order_product dimensions weight_class_id	Classe de peso ("1" padrão para quilo)	Numérico (int)
data order_product dimensions weight	Peso do produto	Numérico (float)
data order_product dimensions length	Comprimento do produto	Numérico (float)
data order_product dimensions width	Largura do produto	Numérico (float)
data order_product dimensions height	Altura do produto	Numérico (float)
data order_product product_attribute	Objeto que contém informações dos atributos do produto comprado	Objeto em JSON
data order_product product_attribute attribute_id	ID do atributo	Numérico (float)
data order_product product_attribute text	Texto do atributo	String
data order_total	Objeto que contém informações do pagamento do pedido	Objeto em JSON
data order_total code	Código do total, para identificação no sistema	String
data order_total title	Título do total (Não deve ser utilizado como identificador, é somente um texto de exibição)	String
data order_total value	Valor deste total específico	Numérico (float)
data order_total sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data order_coupon	Objeto que contém informações do cupom do pedido	Objeto em JSON
data order_coupon type_coupon	gift (Cupom do tipo brinde) ou Percentage (Cupom do tipo porcentagem) ou fixed_value (Cupom do tipo valor fixo)	string
data order_coupon models_coupon	Codigo dos produtos que concederam a utilização do cupom	Objeto em JSON
data order_coupon model_gift_coupon	Código do produto concedido como brinde	Numérico (int)
data order_coupon discount_coupon	Desconto oferencido pelo cupom	string
data is_mirrored	Indica se o pedido é espelhado ou não.	bool
data affiliate	Objeto que contém informações do afiliado responsável pelo pedido	Objeto em JSON
data affiliate affiliate_id	ID do afiliado	Numérico (int)
data affiliate firstname	Primeiro nome do afiliado	String
data affiliate lastname	Sobrenome nome do afiliado	String
data nfe_details	Objeto que contém informações da nota fiscal do pedido	Objeto em JSON
data nfe_details nfe_series	Série da nota fiscal	String
data nfe_details nfe_number	Número da nota fiscal	String
data nfe_details nfe_type	Tipo da nota fiscal	String
data nfe_details nfe_key	Chaave da nota fiscal	String
data nfe_details issue_date	Data de emissão da nota fiscal	String
data nfe_details link_xml	Link do XML da nota fiscal	String
data nfe_details nfe_items	Objeto que contém informações dos itens da nota fiscal	Objeto em JSON
data nfe_details nfe_items product_id	ID do produto	Numérico (int)
data nfe_details nfe_items product_cfop	CFOP do produto	String
data intermediary_name	Nome do intermediador do pagamento	String
data intermediary_cnpj	CNPJ do intermediador do pagamento	String
data intermediary_operation_name	Nome do intermediador da operação	String
data intermediary_operation_cnpj	CNPJ do intermediador da operação	String

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/order/details?page=1&limit=1&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": [
      {
        "order_id": 9115,
        "marketplace_order_id": "010101",
        "marketplace": "Netshoes",
        "store_url": "https://www.loja.com.br/",
        "customer_id": 7237,
        "customer_group_id": 8,
        "return_id": 0,
        "nsu": "627057108",
        "type_person": "F",
        "firstname": "John",
        "lastname": "Doe",
        "email": "john@doe.com",
        "telephone": "(99)9999-9999",
        "cellphone": "(99)99999-9999",
        "cpf_cnpj": "999.999.999-99",
        "rg_ie": "12345678",
        "customer_sex": "F",
        "customer_custom_field": {},
        "number_parcel": 10,
        "payment_firstname": "John Doe",
        "payment_address_1": "R. Nabi Haber",
        "payment_number_home": "465",
        "payment_neighborhood": "São José",
        "payment_address_2": "Casa amarela",
        "payment_city": "Franca",
        "payment_postcode": "14401286",
        "payment_country": "Brasil",
        "payment_zone": "São Paulo",
        "payment_zone_id": 464,
        "payment_method": "Boleto",
        "payment_code": "paypal",
        "payment_condition": "",
        "payment_details": {
            "NSU": "",
            "transaction_id": "",
            "authorization_code": "",
            "billet_line": "",
            "billet_our_number": "",
            "billet_due_date": ""
        },
        "shipping_firstname": "John",
        "shipping_lastname": "Doe",
        "shipping_address_1": "R. Nabi Haber",
        "shipping_number_home": "465",
        "shipping_neighborhood": "São José",
        "shipping_address_2": "Casa Amarela",
        "shipping_city": "Franca",
        "shipping_postcode": "14401286",
        "shipping_country": "Brasil",
        "shipping_zone": "São Paulo",
        "shipping_zone_id": 464,
        "shipping_custom_field":"{}",
        "shipping_method": "Sedex",
        "shipping_delivery_time": 5,
        "melhor_envio_service": "",
        "smart_envios_service": "",
        "data_frete_id_table": "",
        "shipping_code": "sedex.sedex",
        "comment": "",
        "total": "168.5720",
        "order_status_id": 25,
        "tracking": "",
        "date_added": "2017-05-05 11:57:54",
        "date_modified": "2017-05-05 12:00:04",
        "code_tracking": "QL999999999BR",
        "attacked_status": false,
        "pickup_address": "",
        "user_seller": "Seller Test",
        "user_seller_id": 1,
        "external_reference": "999",
        "gift": {
            "product_id": "99",
            "name/model": "Carteira em Couro - Preto",
            "sku": "9999-01",
            "price": "0.0000",
            "total": "0.0000",
            "quantity": 1
        },
        "intelipost_delivery_id": 0,
        "customer_group_name": "Default",
        "cnpj_contact": "",
        "order_history": [
          {
            "order_history_id": 3733566,
            "order_status_id": 5,
            "notify": 1,
            "comment": "Pagamento Aprovado",
            "user_log": "paypal",
            "date_added": "2017-05-05 09:10:55",
            "name": {
              "order_status_id": 5,
              "name": "Pagamento Aprovado"
            }
          },
          {
            "order_history_id": 3733565,
            "order_status_id": 17,
            "notify": 0,
            "comment": "",
            "user_log": "lojista",
            "date_added": "2017-05-05 09:10:33",
            "name": {
              "order_status_id": 17,
              "name": "Aguardando Pagamento"
            }
          }
        ],
        "order_product": [
          {
            "order_product_id": 15947,
            "product_id": 3664,
            "name": "Sapato Masculino",
            "model": "SM-001",
            "quantity": 1,
            "price": "149.9000",
            "price_attacked": "0.0000",
            "total": "149.9000",
            "total_attacked": "0.0000",
            "present": 0,
            "present_value": "0.0000",
            "shipping": 0,
            "shipping_date": "0000-00-00 00:00:00",
            "seller_id": 0,
            "status_id": 0,
            "delivery_method_id": null,
            "shipping_method": null,
            "shipping_value": null,
            "date_modified": "2017-05-01 08:42:30",
            "link_xml_nfe": null,
            "chave_nota": null,
            "free_product_coupon": 0
            "manufacturer_id": 6,
            "options": [
                {
                    "order_option_id": 1515,
                    "product_option_id": 832,
                    "product_option_value_id": 13372,
                    "name": "Tamanho",
                    "value": "Único",
                    "package": 0,
                    "stock_type": "1",
                    "old_subtract": 1,
                    "option_id": 13,
                    "option_value": {
                        "product_option_value_id": 24175,
                        "option_value_id": 255,
                        "product_id": 3664,
                        "quantity": 99,
                        "subtract": 1,
                        "price": "0.00",
                        "price_prefix": "+",
                        "weight": "0.0000",
                        "weight_prefix": "+",
                        "stock_type": "warn_me",
                        "reference": "",
                        "external_reference": "",
                        "name": "Único"
                    }
                }
            ],
            "dimensions": {
                "weight_class_id": 1,
                "weight": "0.3000",
                "length": "0.0000",
                "width": "0.0000",
                "height": "0.0000"
            },
            "product_attribute": [
                {
                    "product_id": 3664,
                    "attribute_disabled": 0,
                    "attribute_id": 1,
                    "language_id": 2,
                    "text": "Sola de borracha",
                    "image": ""
                }
            ]
          }
        ],
        "order_total": [
            {
                "code": "sub_total",
                "title": "Sub-Total",
                "value": "149.9000",
                "sort_order": 1
            },
            {
                "code": "shipping",
                "title": "Sedex",
                "value": "18.6720",
                "sort_order": 3
            },
            {
				"code": "interest",
				"title": "Juros",
				"value": "16.3394",
				"sort_order": 8
			},
            {
                "code": "total",
                "title": "Total",
                "value": "168.5720",
                "sort_order": 9
            }
        ],
        "affiliate": {
            "affiliate_id": 15,
            "firstname": "Marcos",
            "lastname": "Santos"
        },
        "order_coupon": {
            "type_coupon": "gift",
            "models_coupon": [
                "7209",
                "7208"
            ],
            "model_gift_coupon": 5734,
            "discount_coupon": "0.0000",
        },
        "is_mirrored": false,
        "nfe_details": {
            "nfe_series": 1,
            "nfe_number": 11111,
            "nfe_type": "sale",
            "nfe_key": "75308565126579314149644757762599020987500258",
            "issue_date": "2022-01-01 10:10:10",
            "link_xml": "https://www.file.com.br/file.xml",
            "nfe_items": [
                {
                    "product_id": 3664,
                    "product_cfop": "0000"
                }
            ]
        },
        "intermediary_name": "Pagar.me",
        "intermediary_cnpj": "18727053000174",
        "intermediary_operation_cnpj": "13743978000195",
        "intermediary_operation_name": "Intermediador de teste"
    ]
}

/order/{{id}}

Método responsável por retornar um pedido com todas suas informações. Além disso, retornará também:

- Dados dos produtos.

- Totais (Sub-total, forma de envio, descontos e etc).

- Lista de Status do pedido, sendo o último o status atual.

Deverá ser realizado uma requisição GET informando o ID do pedido.

GET https://api.irroba.com.br/v1/order/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todos os pedidos retornados	Objeto em JSON
data customer_birthday	Data de nascimento do cliente	String
data nfe_details	Objeto que contém os detalhes da nota fiscal do pedido (Caso o cliente não utilize nosso módulo para gerar nota fiscal, ou ainda não tenha sido gerado a NFe os campos do JSON serão vazio).	Objeto em JSON
data nfe_details nfe_number	Numero da NFe	Numérico
data nfe_details nfe_type	Tipo da nota fiscal (Venda ou troca e devolução)	String
data nfe_details nfe_key	Chave da NFe	String
data nfe_details issue_date	Data de emissão da NFe	String
data nfe_details link_xml	Link do xml da NFe	String
data nfe_details nfe_items	Objeto em JSON com informações os produtos da NFe	Objeto em JSON
data nfe_details nfe_items product_id	ID do produto	Numérico (int)
data nfe_details nfe_items product_cfop	CFOP do produto	String
data payment_details	Objeto que contém os detalhes do pagamento do pedido (Caso a forma de pagamento não retornem estas informações os campos desse JSON serão vazio).	Objeto em JSON
data payment_details NSU	NSU da transação	Numérico
data payment_details transaction_id	ID da transação	Numérico
data payment_details authorization_code	Código de autorização da transação	String
data payment_details billet_line	Linha digitável do boleto	String
data payment_details billet_our_number	Número do boleto no gateway de pagamento	String
data payment_details billet_due_date	Data de vencimento do boleto	String
data number_of_installments	Quantidade de parcelas	Numérico (int)
data order_id	ID do pedido	Numérico (int)
data marketplace_order_id	ID do pedido dentro do Marketplace	String
data marketplace	Nome do Marketplace	String
data store_url	URL da loja	String
data customer_id	ID do cliente	Numérico (int)
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data return_id	ID do pedido de troca	Numérico (int)
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador	String
data lastname	Sobrenome do cliente comprador	String
data email	Email do cliente comprador	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data payment_firstname	Nome do cliente responsável pelo pagamento	String
data payment_address_1	Endereço do cliente responsável pelo pagamento	String
data payment_number_home	Número (endereço) do cliente responsável pelo pagamento	String
data payment_neighborhood	Bairro do cliente responsável pelo pagamento	String
data payment_address_2	Complemento do endereço do cliente responsável pelo pagamento	String
data payment_city	Cidade do cliente responsável pelo pagamento	String
data payment_postcode	CEP do cliente responsável pelo pagamento	String
data payment_country	País do cliente responsável pelo pagamento	String
data payment_zone	Estado do cliente responsável pelo pagamento	String
data payment_zone_id	ID do estado, conferir tabela de estados	Numérico (int)
data payment_method	Forma de pagamento do pedido (Não deve ser utilizado como identificador, é somente um texto de exibição)	String
data payment_code	Código da Forma de pagamento do pedido (Para de fato identificar uma forma de pagamento)	String
data shipping_firstname	Nome do cliente que irá receber o pedido	String
data shipping_lastname	Sobrenome do cliente que irá receber o pedido	String
data shipping_address_1	Endereço do cliente que irá receber o pedido	String
data shipping_number_home	Número (endereço) do cliente que irá receber o pedido	String
data shipping_neighborhood	Bairro do cliente que irá receber o pedido	String
data shipping_address_2	Complemento do endereço do cliente que irá receber o pedido	String
data shipping_city	Cidade do cliente que irá receber o pedido	String
data shipping_postcode	CEP do cliente que irá receber o pedido	String
data shipping_country	País do cliente que irá receber o pedido	String
data shipping_zone	Estado do cliente que irá receber o pedido	String
data shipping_zone_id	ID do estado, conferir tabela de estados	Numérico (int)
data shipping_custom_field	Campo personalizado da entrega do pedido	String
data shipping_method	Método de envio, conferir tabela de métodos de envio	String
data shipping_delivery_time	Quantidade de dias previsto para a entrega do pedido	String
data shipping_actual_cost	Valor do frete após a postagem	String
data melhor_envio_service	ID da forma de envio na Melhor envio. (Somente sera exibido caso a forma de envio do pedido for Melhor envio).	String
data frenet_service	ID da forma de envio na Frenet. (Somente sera exibido caso a forma de envio do pedido for Frenet).	String
data smart_envios_service	ID da forma de envio na Smart Envio. (Somente sera exibido caso a forma de envio do pedido for Smart Envio).	String
data data_frete_id_table	ID da forma de envio na Data Frete. (Somente sera exibido caso a forma de envio do pedido for Data Frete).	String
data shipping_code	Código da forma de envio (Para de fato identificar a forma de envio selecionada)	String
data comment	Comentário realizado pelo cliente no pedido	String
data total	Valor total da compra	Numérico (float)
data order_status_id	ID do status atual do pedido	Numérico (int)
data tracking	Código de rastreio do pedido (caso já tenha sido enviado)	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data date_modified	Data e horário que o pedido foi alterado (Padrão ISO 8601)	String
data code_tracking	Código de rastreio do pedido (Somente quando o order_status_id for 3)	String
data attacked_status	Identifica se o pedido foi finalizado em atacado	bool
data pickup_address	Endereço que o cliente selecionou para retirar o pedido. (Somente sera exibido caso a forma de envio do pedido for retirar na loja).	String
data user_seller	Nome do vendedor responsável por esse pedido	String
data user_seller_id	ID do vendedor responsável por esse pedido	Numérico (int)
data external_reference	Referência externa utilizado para inserir o ID do pedido em seu ERP	String
data gift product_id	ID do produto	String
data gift name/model	Nome do produto - Nome da opção do produto	String
data gift sku	Model do produto	String
data gift price	Preço do brinde	String
data gift total	Preço total do brinde	String
data gift quantity	Quantidade do brinde	String
data intelipost_delivery_id	ID da forma de envio na Intelipost. (Somente sera exibido caso a forma de envio do pedido for Intelipost).	Numérico (int)
data intermediary_name	Nome do intermediador do pagamento	String
data intermediary_cnpj	CNPJ do intermediador do pagamento	String
data intermediary_operation_name	Nome do intermediador da operação	String
data intermediary_operation_cnpj	CNPJ do intermediador da operação	String
data customer_group_name	Nome do grupo de usuários do cliente	String
data cnpj_contact	Nome do contato para pessoa juridica	String
data customer_sex	Inicial do sexo do comprador	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history name	Nome do status	String
data order_product	Objeto que contém todos os produtos do pedido	Objeto em JSON
data order_product order_product_id	ID do produto neste pedido específico	Numérico (int)
data order_product product_id	ID do produto	Numérico (int)
data order_product name	Nome do produto	String
data order_product model	Código do produto dentro do sistema (Modelo)	String
data order_product quantity	Quantidade adquirida no pedido	Numérico (int)
data order_product price	Preço do produto (no momento da compra)	Numérico (float)
data order_product stock_type	Tipo de estoque do produto (no momento da compra), conforme a tabela de tipos	String (float)
data order_product price_attacked	Preço de atacado do produto (no momento da compra)	Numérico (float)
data order_product total	Preço total para esse produto (de acordo com a quantidade)	Numérico (float)
data order_product total_attacked	Preço total de atacado para esse produto (de acordo com a quantidade)	Numérico (float)
data order_product present	Embalagem de presente, 1 para sim e 0 para não	Numérico (int)
data order_product present_value	Valor da embalagem para presente	Numérico (float)
data order_product manufacturer_id	Id da Marca do produto, Buscar Ids das Marcas cadastradas na loja Marcas	Numérico (int)
data order_product options order_option_id	ID da opção da order	Numérico (int)
data order_product options product_option_id	ID da opção do produto	Numérico (int)
data order_product options product_option_value_id	ID do valor da opção do produto	Numérico (int)
data order_product options name	Nome da opção do produto	String
data order_product options stock_type	Ação do estoque com a quantidade zerada	String
data order_product options old_subtract	Se o produto tinha controle de estoque no momento da compra	Numérico (int)
data order_product options option_id	ID da opção	Numérico (int)
data order_product options option_value product_option_value_id	ID do valor da opção do produto	Numérico (int)
data order_product options option_value option_value_id	ID do valor da opção	Numérico (int)
data order_product options option_value quantity	Quantidade em estoque da opção	Numérico (int)
data order_product options option_value subtract	Define se a variação inserida nos produtos ira controlar estoque ou não (1 = Controla estoque, 0 = Não controla estoque)	Numérico (int)
data order_product options option_value price	Define o valor de acréscimo ou decréscimo do preço da variação	Numérico (float)
data order_product options option_value price_prefix	Define o operador do price da variação	String
data order_product options option_value weight	Define o valor de acréscimo ou decréscimo do peso da variação	Numérico (float)
data order_product options option_value weight_prefix	Define o operador do weight da variação	String
data order_product options option_value reference	Referência da opção de estoque (Utilizada para atualização de quantidades)	String
data order_product options option_value external_reference	Referência externa utilizado para inserir o ID da opção de estoque em seu ERP	String
data order_product options option_value name	Nome da opção	String
data order_product dimensions	Objeto que contém informações das opções do produto comprado	Objeto em JSON
data order_product dimensions weight_class_id	Classe de peso ("1" padrão para quilo)	Numérico (int)
data order_product dimensions weight	Peso do produto	Numérico (float)
data order_product dimensions length	Comprimento do produto	Numérico (float)
data order_product dimensions width	Largura do produto	Numérico (float)
data order_product dimensions height	Altura do produto	Numérico (float)
data order_product product_attribute	Objeto que contém informações dos atributos do produto comprado	Objeto em JSON
data order_product product_attribute attribute_id	ID do atributo	Numérico (float)
data order_product product_attribute text	Texto do atributo	String
data order_total	Objeto que contém todos os produtos do pedido	Objeto em JSON
data order_total code	Código do total, para identificação no sistema	String
data order_total title	Título do total (Não deve ser utilizado como identificador, é somente um texto de exibição)	String
data order_total value	Valor deste total específico	Numérico (float)
data order_total sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)
data affiliate	Objeto que contém informações do afiliado responsável pelo pedido	Objeto em JSON
data affiliate affiliate_id	ID do afiliado	Numérico (int)
data affiliate firstname	Primeiro nome do afiliado	String
data affiliate lastname	Sobrenome nome do afiliado	String
data is_mirrored	Indica se o pedido é espelhado ou não.	bool
data payment_condition	Condição de pagamento (Apenas para pagamento por faturamento)	String
data text_purchase_order_field	Código de ordem de compra	String
data months_purchased	Quantidade que indica para quantos meses será o pedido	Numérico (int)

{
    "success": "true",
    "data": {
        "customer_birthday": "2000-01-01",
        "nfe_details": {
            "nfe_series": 1,
            "nfe_number": 11111,
            "nfe_type": "sale",
            "nfe_key": "75308565126579314149644757762599020987500258",
            "issue_date": "2022-01-01 10:10:10",
            "link_xml": "https://www.file.com.br/file.xml",
            "nfe_items": [
                {
                    "product_id": 3664,
                    "product_cfop": "0000"
                }
            ]
        },
        "payment_details": {
            "NSU": "",
            "transaction_id": "",
            "authorization_code": "",
            "billet_line": "",
            "billet_our_number": "",
            "billet_due_date": ""
        },
        "number_of_installments": 1,
        "order_id": 9115,
        "markeplace_order_id": "010101",
        "marketplace": "Netshoes",
        "store_url": "https:\/\/www.loja.com.br\/",
        "customer_id": 22627,
        "customer_group_id": 8,
        "return_id": 0,
        "type_person": "F",
        "firstname": "John",
        "lastname": "Doe",
        "email": "john@doe.com",
        "telephone": "(99)9999-9999",
        "cellphone": "(99)9999-9999",
        "cpf_cnpj": "99999999999",
        "rg_ie": "12345678",
        "payment_firstname": "John",
        "payment_address_1": "R. Nabi Haber",
        "payment_number_home": "465",
        "payment_neighborhood": "São José",
        "payment_address_2": "Casa amarela",
        "payment_city": "Franca",
        "payment_postcode": "14401286",
        "payment_country": "Brasil",
        "payment_zone": "São Paulo",
        "payment_zone_id": 451,
        "payment_method": "Netshoes",
        "payment_code": "netshoes_payment",
        "shipping_firstname": "John",
        "shipping_lastname": "Doe",
        "shipping_address_1": "R. Nabi Haber",
        "shipping_number_home": "465",
        "shipping_neighborhood": "São José",
        "shipping_address_2": "Casa Amarela",
        "shipping_city": "Franca",
        "shipping_postcode": "14401286",
        "shipping_country": "Brasil",
        "shipping_zone": "São Paulo",
        "shipping_zone_id": 451,
        "shipping_custom_field": "",
        "shipping_method": "Netshoes",
        "shipping_delivery_time": 12,
        "shipping_actual_cost": "0.00",
        "melhor_envio_service": null,
        "frenet_service": null,
        "smart_envios_service": "",
        "data_frete_id_table": "0",
        "shipping_code": "pac.pac",
        "comment": "",
        "total": "142.0000",
        "order_status_id": 25,
        "tracking": "",
        "date_added": "2017-05-05 11:57:54",
        "date_modified": "2017-05-05 12:00:04",
        "code_tracking": null,
        "attacked_status": false,
        "pickup_address": null,
        "user_seller": "Seller Test 1",
        "user_seller_id": 1,
        "external_reference": "0",
        "gift": {
            "product_id": "99",
            "name/model": "Carteira em Couro - Preto",
            "sku": "9999-01",
            "price": "0.0000",
            "total": "0.0000",
            "quantity": 1
        },
        "intelipost_delivery_id": null,
        "intermediary_name": "Magalu Pagamentos",
        "intermediary_cnpj": "17948578000177",
        "intermediary_operation_cnpj": "13743978000195",
        "intermediary_operation_name": "Intermediador de teste",
        "customer_group_name": "Default",
        "cnpj_contact": null,
        "customer_sex": "F",
        "order_history": [
            {
                "order_history_id": 3733566,
                "order_status_id": 5,
                "notify": 1,
                "comment": "Pagamento Aprovado",
                "user_log": "paypal",
                "date_added": "2017-05-05 09:10:55",
                "name": {
                    "order_status_id": 5,
                    "name": "Pagamento Aprovado"
                }
            },
            {
                "order_history_id": 3733565,
                "order_status_id": 17,
                "notify": 0,
                "comment": "",
                "user_log": "lojista",
                "date_added": "2017-05-05 09:10:33",
                "name": {
                    "order_status_id": 17,
                    "name": "Aguardando Pagamento"
                }
            }
        ],
        "order_product": [
            {
                "order_product_id": 350586,
                "product_id": 4040,
                "name": "Sapatenis Azul Jeans",
                "model": "07832-2415",
                "quantity": 1,
                "price": "149.9000",
                "price_attacked": "0.0000",
                "total": "149.9000",
                "total_attacked": "0.0000",
                "present": 0,
                "present_value": "0.0000",
                "shipping": 0,
                "shipping_date": "0000-00-00 00:00:00",
                "seller_id": 0,
				"status_id": 0,
				"delivery_method_id": null,
				"shipping_method": null,
				"shipping_value": null,
				"date_modified": "2017-01-01 07:45:03",
				"link_xml_nfe": null,
				"chave_nota": null,
                "manufacturer_id": 6,
                "options": [
                    {
                        "order_option_id": 346378,
                        "product_option_id": 3559,
                        "product_option_value_id": 12668,
                        "name": "Tamanho",
                        "value": "39",
                        "package": 0,
                        "stock_type": "1",
                        "old_subtract": 1,
                        "option_id": 13,
                        "option_value": {
                            "product_option_value_id": 12668,
                            "option_value_id": 115,
                            "quantity": 977,
                            "subtract": 1,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "reference": "07832-2415-39",
                            "external_reference": "0",
                            "name": "39"
                        }
                    }
                ],
                "dimensions": {
                    "weight_class_id": 1,
                    "weight": "0.8900",
                    "length": "30.0000",
                    "width": "20.0000",
                    "height": "17.0000"
                },
                "product_attribute": [
                    {
                        "product_id": 3664,
                        "attribute_disabled": 0,
                        "attribute_id": 1,
                        "language_id": 2,
                        "text": "Sola de borracha",
                        "image": ""
                    }
                ]
            }
        ],
        "order_total": [
            {
                "code": "sub_total",
                "title": "Sub-Total",
                "value": "149.9000",
                "sort_order": 1
            },
            {
                "code": "shipping",
                "title": "Sedex",
                "value": "18.6720",
                "sort_order": 3
            },
            {
				"code": "interest",
				"title": "Juros",
				"value": "16.3394",
				"sort_order": 8
			},
            {
                "code": "total",
                "title": "Total",
                "value": "168.5720",
                "sort_order": 9
            }
        ],
        "affiliate": {
            "affiliate_id": 15,
            "firstname": "Marcos",
            "lastname": "Santos"
        },
        "is_mirrored": false,
        "payment_condition": "",
        "text_purchase_order_field": "",
		"months_purchased": 1
    }
}

/order/customer/{{id}}

Método responsável por retornar os pedidos com todas suas informações de um cliente específico. Além disso, retornará também:

- Dados dos produtos.

- Totais (Sub-total, forma de envio, descontos e etc).

- Lista de Status do pedido, sendo o último o status atual.

Deverá ser realizado uma requisição GET informando o ID do cliente (customer).

Há a possibilidade de ordenar os dados de acordo com a tabela.

GET https://api.irroba.com.br/v1/order/customer/{{id}}

Resposta

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com todos os pedidos retornados	Objeto em JSON
data order_id	ID do pedido	Numérico (int)
data marketplace_order_id	ID do pedido dentro do Marketplace	String
data marketplace	Nome do Marketplace	String
data customer_id	ID do cliente	Numérico (int)
data customer_group_id	ID do grupo de usuário do cliente (8 é o grupo padrão de clientes)	Numérico (int)
data return_id	ID do pedido de troca	Numérico (int)
data type_person	Indica se é pessoa física (F) ou pessoa jurídica (J)	String
data firstname	Nome do cliente comprador	String
data email	Email do cliente comprador	String
data telephone	Telefone do cliente, pode haver ou não formatação	String
data cellphone	Celular do cliente, pode haver ou não formatação	String
data cpf_cnpj	CPF / CNPJ do cliente, pode haver ou não formatação	String
data rg_ie	RG / IE (Inscrição Estadual) do cliente, pode haver ou não formatação	String
data payment_firstname	Nome do cliente responsável pelo pagamento	String
data payment_address_1	Endereço do cliente responsável pelo pagamento	String
data payment_number_home	Número (endereço) do cliente responsável pelo pagamento	String
data payment_neighborhood	Bairro do cliente responsável pelo pagamento	String
data payment_address_2	Complemento do endereço do cliente responsável pelo pagamento	String
data payment_city	Cidade do cliente responsável pelo pagamento	String
data payment_postcode	CEP do cliente responsável pelo pagamento	String
data payment_country	País do cliente responsável pelo pagamento	String
data payment_zone	Estado do cliente responsável pelo pagamento	String
data payment_method	Forma de pagamento do pedido (Não deve ser utilizado como identificador, é somente um texto de exibição)	String
data payment_code	Código da Forma de pagamento do pedido (Para de fato identificar uma forma de pagamento)	String
data shipping_address_1	Endereço do cliente que irá receber o pedido	String
data shipping_number_home	Número (endereço) do cliente que irá receber o pedido	String
data shipping_neighborhood	Bairro do cliente que irá receber o pedido	String
data shipping_address_2	Complemento do endereço do cliente que irá receber o pedido	String
data shipping_city	Cidade do cliente que irá receber o pedido	String
data shipping_postcode	CEP do cliente que irá receber o pedido	String
data shipping_country	País do cliente que irá receber o pedido	String
data shipping_zone	Estado do cliente que irá receber o pedido	String
data shipping_code	Código da forma de envio (Para de fato identificar a forma de envio selecionada)	String
data comment	Comentário realizado pelo cliente no pedido	String
data total	Valor total da compra	Numérico (float)
data order_status_id	ID do status atual do pedido	Numérico (int)
data tracking	Código de rastreio do pedido (caso já tenha sido enviado)	String
data date_added	Data e horário que o pedido foi realizado (Padrão ISO 8601)	String
data date_modified	Data e horário que o pedido foi alterado (Padrão ISO 8601)	String
data attacked_status	Identifica se o pedido foi finalizado em atacado	bool
data customer_group_name	Nome do grupo de usuários do cliente	String
data order_history	Objeto que contém todos os históricos do pedido	Objeto em JSON
data order_history order_history_id	ID do histórico específico (Único)	Numérico (int)
data order_history order_status_id	ID do status (Único)	Numérico (int)
data order_history notify	Indica se o cliente final foi notificado desta ação	Numérico (int)
data order_history comment	Comentário da atualização de status	String
data order_history user_log	Usuário responsável pela atualização	String
data order_history date_added	Data e horário de adição do histórico (Padrão ISO 8601)	String
data order_history name	Objeto em JSON com informações do status	Objeto em JSON
data order_history name order_status_id	ID do status (Único)	Numérico (int)
data order_history name name	Nome do status	String
data order_product	Objeto que contém todos os produtos do pedido	Objeto em JSON
data order_product order_product_id	ID do produto neste pedido específico	Numérico (int)
data order_product product_id	ID do produto	Numérico (int)
data order_product name	Nome do produto	String
data order_product model	Código do produto dentro do sistema (Modelo)	String
data order_product quantity	Quantidade adquirida no pedido	Numérico (int)
data order_product price	Preço do produto (no momento da compra)	Numérico (float)
data order_product price_attacked	Preço de atacado do produto (no momento da compra)	Numérico (float)
data order_product total	Preço total para esse produto (de acordo com a quantidade)	Numérico (float)
data order_product total_attacked	Preço total de atacado para esse produto (de acordo com a quantidade)	Numérico (float)
data order_total	Objeto que contém todos os produtos do pedido	Objeto em JSON
data order_total code	Código do total, para identificação no sistema	String
data order_total title	Título do total (Não deve ser utilizado como identificador, é somente um texto de exibição)	String
data order_total value	Valor deste total específico	Numérico (float)
data order_total sort_order	Ordenação do total na hora da exibição (Do menor para o maior)	Numérico (int)

{
  "success": "true",
  "pagination": {
    "currentPage": 1,
    "previousPageUrl": null,
    "nextPageUrl": "https://api.irroba.com.br/v1/order/customer/1?page=1&limit=1&sort=date_added&order=DESC",
    "firstItem": 1,
    "lastItem": 2
  },
  "data": {
    "order_id": 9115,
    "marketplace_order_id": "010101",
    "marketplace": "Netshoes",
    "customer_id": 7237,
    "customer_group_id": 8,
    "return_id": 0,
    "type_person": "F",
    "firstname": "John Doe",
    "email": "john@doe.com",
    "telephone": "(99)9999-9999",
    "cellphone": "(99)99999-9999",
    "cpf_cnpj": "999.999.999-99",
    "rg_ie": "12345678",
    "payment_firstname": "John Doe",
    "payment_address_1": "R. Nabi Haber",
    "payment_number_home": "465",
    "payment_neighborhood": "São José",
    "payment_address_2": "Casa amarela",
    "payment_city": "Franca",
    "payment_postcode": "14401286",
    "payment_country": "Brasil",
    "payment_zone": "São Paulo",
    "payment_method": "Boleto",
    "payment_code": "paypal",
    "shipping_firstname": "John Doe",
    "shipping_address_1": "R. Nabi Haber",
    "shipping_number_home": "465",
    "shipping_neighborhood": "São José",
    "shipping_address_2": "Casa Amarela",
    "shipping_city": "Franca",
    "shipping_postcode": "14401286",
    "shipping_country": "Brasil",
    "shipping_zone": "São Paulo",
    "shipping_code": "sedex.sedex",
    "comment": "",
    "total": "168.5720",
    "order_status_id": 25,
    "tracking": "",
    "date_added": "2017-05-05 11:57:54",
    "date_modified": "2017-05-05 12:00:04",
    "attacked_status": false,
    "customer_group_name": "Default",
    "order_history": [
      {
        "order_history_id": 3733566,
        "order_status_id": 5,
        "notify": 1,
        "comment": "Pagamento Aprovado",
        "user_log": "paypal",
        "date_added": "2017-05-05 09:10:55",
        "name": {
          "order_status_id": 5,
          "name": "Pagamento Aprovado"
        }
      },
      {
        "order_history_id": 3733565,
        "order_status_id": 17,
        "notify": 0,
        "comment": "",
        "user_log": "lojista",
        "date_added": "2017-05-05 09:10:33",
        "name": {
          "order_status_id": 17,
          "name": "Aguardando Pagamento"
        }
      }
    ],
    "order_product": [
      {
        "order_product_id": 15947,
        "product_id": 3664,
        "name": "Sapato Masculino",
        "model": "SM-001",
        "quantity": 1,
        "price": "149.9000",
        "price_attacked": "0.0000",
        "total": "149.9000",
        "total_attacked": "0.0000"
      }
    ],
    "order_total": [
      {
        "code": "sub_total",
        "title": "Sub-Total",
        "value": "149.9000",
        "sort_order": 1
      },
      {
        "code": "shipping",
        "title": "Sedex",
        "value": "18.6720",
        "sort_order": 3
      },
      {
        "code": "total",
        "title": "Total",
        "value": "168.5720",
        "sort_order": 9
      }
    ]
  }
}

/order/{{id}}/invoice

Método responsável por adicionar informações fiscais para um pedido através do order_id.

Deverá ser realizado uma requisição POST com o request necessário e informando na URL o ID do pedido.

POST https://api.irroba.com.br/v1/order/{{id}}/invoice

Requisição

Nome	Descrição	Formato
key	Chave da nota fiscal	String / Obrigatório
number	Numero da nota fiscal	String / Opcional
cnpj	CNPJ do responsável pela emissão da Nota	String / Obrigatório
send	Envio de e-mail com a nota fiscal	String / Opcional
domain	URL da loja	String / Opcional
xml	XML da nota fiscal	String / Obrigatório

{
    "key": "99000099949900000999900000000099999999999999",
    "number": "1000",
    "cnpj": "99999999999990",
    "send": "true",
    "domain": "URL da loja",
    "xml": "<?xml version='1.0' ..."
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Order successfully Invoiced!"
}

/order

Método responsável por adicionar um Pedido.

Deverá ser realizado uma requisição POST com o request necessário.

POST https://api.irroba.com.br/v1/order

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do pedido	Objeto em JSON
data customer_id	ID do cliente caso o cliente ja esteja cadastrado na plataforma	Numérico (int)
data type_person	Indica se é pssoa física (F) ou pessoa jurídica (J)	String / Obrigatório (Se o customer_id for 0)
data firstname	Nome do cliente comprador (Pessoa Física é o nome completo / Pessoa Jurídica é a Razão Social)	String / Obrigatório (Se o customer_id for 0)
data email	Email do cliente comprador	String / Obrigatório (Se o customer_id for 0)
data cpf_cnpj	CPF / CNPJ do cliente	String / Obrigatório
data birthday	Data de nascimento	String / Obrigatório (Se o customer_id for 0)
data sex	Sexo (M) Masculino ou (F) Feminino	String / Obrigatório (Se o customer_id for 0)
data cellphone	Celular do cliente	String / Obrigatório (Se o customer_id for 0)
data payment_method	Forma de pagamento	String / Obrigatório
data shipping_method	Forma de envio	String / Obrigatório
data comment	Comentario no pedido	String
data total	Total do pedido	Numérico (float)
data address	Json com informações do endereço do cliente	JSON / Obrigatório (Se o customer_id for 0)
data address address_1	Endereço do cliente	String / Obrigatório (Se o customer_id for 0)
data address address_2	Complemento	String
data address number_home	Número	Numérico (int) / Obrigatório (Se o customer_id for 0)
data address neighborhood	Bairro	String / Obrigatório (Se o customer_id for 0)
data address city	Cidade	String / Obrigatório (Se o customer_id for 0)
data address postcode	CEP	String / Obrigatório (Se o customer_id for 0)
data address zone_id	ID do estado, conferir tabela de estados	Numérico (int) / Obrigatório (Se o customer_id for 0)
data order_product	Json com informações dos produtos	JSON / Obrigatório
data order_product product_id	Código do produto	String
data order_product product_option_value_id	ID da opção de estoque vendido. (Caso seja apenas uma opção, preencher o campo com o ID. Para mais de uma opção no produto, enviar um array com os IDs)	Numérico (int) / Objeto em JSON
data order_product product_option_text	Utilizado somente em casos onde a variação é do tipo "text", array contendo outro array com os campos "product_option_id" e "text", onde "text" é o conteúdo da grade de texto	Objeto em JSON
data order_product quantity	Quantidade deste produto vendido	Numérico (int)
data order_product price	Preço do produto	Numérico (float) / Obrigatório (Se o model ou o product_id for 0)
data order_total	Json com os totais do pedido	JSON / Obrigatório
data order_total code	Código do total (shipping ou discount)	String / Obrigatório
data order_total title	Titulo do total	String / Obrigatório
data order_total value	Valor do acréscimo ou desconto	Numérico (float) / Obrigatório

{
    "customer_id": 0,
    "type_person": "F",
    "firstname": "Teste API",
    "email": "api1234pedido@irroba.com.br",
    "cpf_cnpj": "11111122233",
    "birthday": "1995-09-04",
    "sex": "M",
    "cellphone": "(16)993118372",
    "address":[
        {
            "address_1":"Rua teste",
            "address_2": "apt 457",
            "number_home":543,
            "neighborhood": "Centro",
            "city": "Franca",
            "postcode":"14405-130",
            "zone_id": 464
        }
    ],
    "payment_method": "Pedido Interno",
    "shipping_method": "PAC",
    "comment": "Pedido de teste pela API",
    "total": 748.65,
    "order_product": [
        {
            "product_id": "0",
            "product_option_value_id": [
                12115,
                12120
            ],
            "product_option_text": [
                {
                    "product_option_id": 140,
                    "text": "TESTE"
                },
                {
                    "product_option_id": 135,
                    "text": "TESTE1"
                }
            ],
            "name": "Sapato teste",
            "price": 120.00,
            "quantity": 1
        }
    ],
    "order_total": [
        {
            "code": "shipping",
            "title": "Forma de Envio",
            "value": 10.00
        }
    ]
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Order inserted successfully!",
    "order_id": 10007
}

/order/{{id}}/status

Método responsável por atualizar o Status de um pedido através do order_id.

Deverá ser realizado uma requisição PUT com o request necessário e informando na URL o ID do pedido.

PUT https://api.irroba.com.br/v1/order/{{id}}/status

Requisição

Nome	Descrição	Formato
order_status_id	ID para atualização de status, conforme a tabela de status	Numérico (int) / Obrigatório
notify	Notificar o cliente sobre a alteração (Notificar = 1 / Não notificar = 0)	Numérico (int)
comment	Comentário sobre a atualização	String
code_tracking	Código de rastreio do pedido (Somente quando o order_status_id for 3)	String

{
    "order_status_id": 3,
    "notify": 1,
    "comment": "Seu pedido foi atualizado e...",
    "code_tracking": "BRC12345678SP"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Order Status updated successfully!"
}

/order/{{id}}/reference

Método responsável por atualizar o external_reference de um pedido através do order_id.

Deverá ser realizado uma requisição PUT com o request necessário e informando na URL o ID do pedido.

PUT https://api.irroba.com.br/v1/order/{{id}}/reference

Requisição

Nome	Descrição	Formato
external_reference	Reference para atualização	String / Obrigatório

{
    "external_reference": 3,
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Order reference updated successfully!"
}

Affiliate (Afiliados)

Tabela para consultar o bank_febraban_id.

bank_febraban_id	title
1	000 - Empresa/Pessoal
2	Banco A.J.Renner S.A.
3	Banco ABC Brasil S.A.
4	Banco ABN AMRO S.A.
6	Banco Alfa S.A.
7	Banco Alvorada S.A.
8	Banco AndBank (Brasil) S.A.
9	Banco Arbi S.A.
10	Banco Azteca do Brasil S.A.
12	Banco BANDEPE S.A.
13	Banco Banerj S.A.
15	Banco Barclays S.A.
16	Banco BBM S.A.
17	Banco Beg S.A.
19	Banco BM&FBOVESPA de Serviços de Liquidação e Custódia S.A.
20	Banco BMG S.A.
21	Banco BNP Paribas Brasil S.A.
22	Banco Boavista Interatlântico S.A.
23	Banco Bonsucesso S.A.
25	Banco Bradesco BBI S.A.
26	Banco Bradesco Cartões S.A.
27	Banco Bradesco Financiamentos S.A.
28	Banco Bradesco S.A.
29	Banco Brascan S.A.
31	Banco BTG Pactual S.A.
32	Banco BVA S.A.
33	Banco Cacique S.A.
34	Banco Caixa Geral - Brasil S.A.
35	Banco Capital S.A.
36	Banco Cargill S.A.
38	Banco Cédula S.A.
39	Banco Cetelem S.A.
40	Banco Cifra S.A.
41	Banco Citibank S.A.
43	Banco Clássico S.A.
45	Banco Comercial e de Investimento Sudameris S.A.
47	Banco Confidence de Câmbio S.A.
48	Banco Cooperativo do Brasil S.A. - BANCOOB
49	Banco Cooperativo Sicredi S.A.
50	Banco Credibel S.A.
51	Banco Credit Agricole Brasil S.A.
52	Banco Credit Suisse (Brasil) S.A.
53	Banco Cruzeiro do Sul S.A.
55	Banco da Amazônia S.A.
58	Banco Daycoval S.A.
61	Banco de La Nacion Argentina
62	Banco de La Provincia de Buenos Aires
63	Banco de La Republica Oriental del Uruguay
65	Banco de Tokyo-Mitsubishi UFJ Brasil S.A.
66	Banco Dibens S.A.
67	Banco do Brasil S.A.
68	Banco do Estado de Sergipe S.A.
69	Banco do Estado do Pará S.A.
70	Banco do Estado do Piauí S.A. - BEP
71	Banco do Estado do Rio Grande do Sul S.A.
72	Banco do Nordeste do Brasil S.A.
73	Banco Fator S.A.
75	Banco Fibra S.A.
76	Banco Ficsa S.A.
82	Banco Gerdau S.A.
84	Banco Guanabara S.A.
86	Banco Ibi S.A. Banco Múltiplo
88	Banco Industrial do Brasil S.A.
89	Banco Industrial e Comercial S.A.
90	Banco Indusval S.A.
91	Banco Intercap S.A.
92	Banco Intermedium S.A.
93	Banco Investcred Unibanco S.A.
95	Banco Itaú BBA S.A.
96	Banco ItaúBank S.A
100	Banco J. P. Morgan S.A.
101	Banco J. Safra S.A.
102	Banco John Deere S.A.
103	Banco KDB S.A.
104	Banco KEB do Brasil S.A.
105	Banco Luso Brasileiro S.A.
106	Banco Máxima S.A.
109	Banco Mercantil do Brasil S.A.
111	Banco Mizuho do Brasil S.A.
112	Banco Modal S.A.
114	Banco Morada S.A.
116	Banco Morgan Stanley S.A.
117	Banco Opportunity S.A.
118	Banco Original do Agronegócio S.A.
119	Banco Original S.A.
122	Banco PAN S.A.
123	Banco Paulista S.A.
124	Banco Pecúnia S.A.
126	Banco Pine S.A.
128	Banco Porto Seguro S.A.
129	Banco Pottencial S.A.
130	Banco Prosper S.A.
132	Banco Rabobank International Brasil S.A.
134	Banco Real S.A.
135	Banco Rendimento S.A.
136	Banco Ribeirão Preto S.A.
139	Banco Rural Mais S.A.
140	Banco Rural S.A.
140	Banco Rural Mais S.A.
141	Banco Safra S.A.
142	Banco Santander (Brasil) S.A.
143	Banco Semear S.A.
144	Banco Simples S.A.
145	Banco Société Générale Brasil S.A.
146	Banco Sofisa S.A.
147	Banco Standard de Investimentos S.A.
149	Banco Sumitomo Mitsui Brasileiro S.A.
152	Banco Triângulo S.A.
153	Banco Tricury S.A.
156	Banco Votorantim S.A.
157	Banco VR S.A.
158	Banco Western Union do Brasil S.A.
161	BANESTES S.A. Banco do Estado do Espírito Santo
163	Banif-Banco Internacional do Funchal (Brasil)S.A.
164	Bank of America Merrill Lynch Banco Múltiplo S.A.
165	BankBoston N.A.
167	BB Banco Popular do Brasil S.A.
169	BCV - Banco de Crédito e Varejo S.A.
170	BES Investimento do Brasil S.A.-Banco de Investimento
173	BPN Brasil Banco Múltiplo S.A.
175	Brasil Plural S.A. - Banco Múltiplo
176	BRB - Banco de Brasília S.A.
180	Caixa Econômica Federal
182	Citibank S.A.
184	CONFEDERACAO NACIONAL DAS COOPERATIVAS CENTRAIS UNICREDS
192	Deutsche Bank S.A. - Banco Alemão
194	Goldman Sachs do Brasil Banco Múltiplo S.A.
195	Hipercard Banco Múltiplo S.A.
196	HSBC Bank Brasil S.A. - Banco Múltiplo
197	HSBC Finance (Brasil) S.A. - Banco Múltiplo
199	ING Bank N.V.
200	Itaú Unibanco Holding S.A.
201	Itaú Unibanco S.A.
203	JPMorgan Chase Bank
204	Natixis Brasil S.A. Banco Múltiplo
205	NBC Bank Brasil S.A. - Banco Múltiplo
208	Paraná Banco S.A.
211	Scotiabank Brasil S.A. Banco Múltiplo
216	UNIBANCO - União de Bancos Brasileiros S.A.
217	Unicard Banco Múltiplo S.A.
218	Nu Pagamentos S.A.
219	Pagseguro Internet S.A.

/affiliate

Método responsável por retornar uma lista com os dados de todos os afiliados, como por exemplo o affiliate_id, necessário para preencher o campo affiliate_parente_id, responsável por vincular um afiliado Pai em um afiliado filho.

Deverá ser realizado uma requisição GET

GET https://api.irroba.com.br/v1/affiliate

Resposta

Caso não ocorra nenhum problema, os seguinte dados serão retornados:

Nome	Descrição	Formato
pagination	Objeto com informações da paginação	Objeto em JSON
pagination currentPage	Página atual	Numérico (int)
pagination previousPage	URL da página anterior (ou null caso não exista)	String
pagination nextPage	URL da próxima página (ou null caso não exista)	String
pagination firstItem	Índice do primeiro item dessa página	Numérico (int)
pagination lastItem	Índice do último item dessa página	Numérico (int)
data	Objeto com os dados do afiliado	Objeto em JSON
data affiliate_id	ID do afiliado	String
data firstname	Primeiro nome do afiliado	String
data lastname	Segundo nome do afiliado	String
data email	Email do afiliado	String
data telephone	Telefone do afiliado	String
data cellphone	Celular do afiliado	String
data address_1	Endereço do afiliado	String
data neighborhood	Bairro	String
data city	Cidade	String
data postcode	Cep do afiliado	String
data zone_id	ID do estado, conferir tabela de estados	Int
data code	Código de afiliação	String
data cpf_cnpj	CPF ou CNPJ do afiliado	String
data status	Status do afiliado	Int
data approved	Aprovação do afiliado	Int

{
    "success": true,
    "pagination": {
        "current_page": 1,
        "per_page": 10,
        "total": 20,
        "last_page": 2
    },
    "data": [
        {
            "affiliate_id": 1,
            "firstname": "teste01",
            "lastname": "",
            "email": "teste01@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e0",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 2,
            "firstname": "teste02",
            "lastname": "",
            "email": "teste02@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 3,
            "firstname": "teste03",
            "lastname": "",
            "email": "teste03@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 4,
            "firstname": "teste04",
            "lastname": "",
            "email": "teste04@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 5,
            "firstname": "teste05",
            "lastname": "",
            "email": "teste05@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 6,
            "firstname": "teste06",
            "lastname": "",
            "email": "teste06@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e0",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 7,
            "firstname": "teste07",
            "lastname": "",
            "email": "teste07@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 8,
            "firstname": "teste08",
            "lastname": "",
            "email": "teste08@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 9,
            "firstname": "teste09",
            "lastname": "",
            "email": "teste09@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        },
        {
            "affiliate_id": 10,
            "firstname": "teste10",
            "lastname": "",
            "email": "teste10@irroba.com.br",
            "telephone": "",
            "cellphone": "(16) 11111-1111",
            "address_1": "Rua Nabi Haber",
            "neighborhood": "São José",
            "postcode": "1440128",
            "zone_id": 464,
            "code": "66ba3858051e1",
            "cpf_cnpj": "",
            "status": 1,
            "approved": 0
        }
    ]
}

/affiliate/{{id}}

Método responsável por retornar os dados de um afiliado em específico, como por exemplo o affiliate_id, necessário para preencher o campo affiliate_parente_id, responsável por vincular um afiliado Pai em um afiliado filho.

Deverá ser realizado uma requisição GET informando o código de afiliação (code) do afiliado.

Esse código está disponível na aps, na página de afiliados

GET https://api.irroba.com.br/v1/affiliate/{{id}}

Resposta

Caso não ocorra nenhum problema, os seguinte dados serão retornados:

Nome	Descrição	Formato
data	Objeto com os dados do afiliado	Objeto em JSON
data affiliate_id	ID do afiliado	String
data firstname	Primeiro nome do afiliado	String
data lastname	Segundo nome do afiliado	String
data email	Email do afiliado	String
data telephone	Telefone do afiliado	String
data cellphone	Celular do afiliado	String
data address_1	Endereço do afiliado	String
data neighborhood	Bairro	String
data city	Cidade	String
data postcode	Cep do afiliado	String
data zone_id	ID do estado, conferir tabela de estados	Int
data code	Código de afiliação	String
data cpf_cnpj	CPF ou CNPJ do afiliado	String
data status	Status do afiliado	Int
data approved	Aprovação do afiliado	Int

{
    "affiliate_id": 18,
    "firstname": "Arthur Henrique teste Irroba",
    "lastname": "",
    "email": "arthur.depaula@irroba.com.br",
    "telephone": "",
    "cellphone": "(99)9999-99999",
    "address_1": "Rua Nabi Haber",
    "neighborhood": "São José","city": "Franca",
    "postcode": "14401286",
    "zone_id": 464,
    "code": "657aeebc76672",
    "cpf_cnpj": "95852134783",
    "status": 1,
    "approved": 0
}

/insertAffiliate

Método responsável por inserir um afiliado

Deverá ser realizado uma requisição POST com o request necessário.

Bank_febraban_id pode ser localizado na tabela de bank_febraban_id.

O affiliate_id, necessário para preencher o campo affiliate_parente_id, responsável por vincular um afiliado Pai em um afiliado filho pode ser adquirido via https://api.irroba.com.br/v1/affiliate.

POST https://api.irroba.com.br/v1/insertAffiliate

Requisição

Nome	Descrição	Formato
data	Objeto com os dados do afiliado	Objeto em JSON
data firstname	Primeiro nome do afiliado	String
data email	Email do afiliado	String
data telephone	Telefone do afiliado	String
data cellphone	Celular do afiliado	String
data password	Senha do afiliado	String
data company	Empresa do afiliado	String
data website	Site/Blog	String
data address_1	Endereço do afiliado	String
data address_2	Complemento do afiliado	String
data number_home	Número do afiliado	String
data neighborhood	Bairro	String
data city	Cidade	String
data postcode	Cep do afiliado	String
data zone_id	ID do estado, conferir tabela de estados	Int
data affiliate_parent_id	ID do afiliado Pai consultar o affiliate_id do pai e inserir o mesmo nesse campo, consulta feita a partir da rota https://api.irroba.com.br/v1/affiliate	Int
data comission	Comissão do afiliado	Decimal [0.00]
data cpf_cnpj	CPF ou CNPJ do afiliado	String
data bank_febraban_id	ID respectivo ao banco utilizado, consultar na tabela de bank_febraban	Int
data bank_branch_number	Agência	String
data bank_branch_number_dv	Dígito da Agência	String
data bank_account_name	Titular	String
data bank_account_number	Conta Corrente	String
data bank_account_number_dv	Dígito da Conta	String
data bank_account_operation	Operação	String
data pix_key	Chave PIX	String
data status	Status do afiliado	Int
data approved	Aprovação do afiliado	Int

{
    "firstname" : "Nome testefinal",
    "email" : "8irroba.irroba@irroba.com.br",
    "telephone" : "(99)9999-99999",
    "cellphone" : "(99)9999-99999",
    "password" : "teste123",
    "company" : "companhia",
    "website" : "https://integracoes.irroba.com.br/aps/index.php?",
    "address_1" : "Rua Nabi Haber",
    "address_2" : "casa de esquina",
    "number_home" : "465",
    "neighborhood" : "são josé",
    "city" : "Franca",
    "postcode" : "14401286",
    "zone_id" : 464,
    "affiliate_parent_id" : 18,
    "commission" : 10,
    "cpf_cnpj" : "59529730861",
    "bank_febraban_id" : 1,
    "bank_branch_number" : "0105",
    "bank_branch_number_dv" : "0",
    "bank_account_name" : "irroba teste",
    "bank_account_number" : "00012345",
    "bank_account_number_dv" : "0",
    "bank_account_operation" : "010",
    "pix_key" : "54818724475",
    "status" : 1,
    “approved” : 1
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Affiliate successfully registered"
}

/updateAffiliate

Método responsável por atualizar um afiliado

Deverá ser realizado uma requisição PUT com o request necessário.

Bank_febraban_id pode ser localizado na tabela de bank_febraban_id.

O affiliate_id, necessário para preencher o campo affiliate_parente_id, responsável por vincular um afiliado Pai em um afiliado filho pode ser adquirido via https://api.irroba.com.br/v1/affiliate.

PUT https://api.irroba.com.br/v1/updateAffiliate

Requisição

Nome	Descrição	Formato
data	Objeto com os dados do afiliado	Objeto em JSON
data firstname	Primeiro nome do afiliado	String
data email	Email do afiliado	String
data telephone	Telefone do afiliado	String
data cellphone	Celular do afiliado	String
data password	Senha do afiliado	String
data company	Empresa do afiliado	String
data website	Site/Blog	String
data address_1	Endereço do afiliado	String
data address_2	Complemento do afiliado	String
data number_home	Número do afiliado	String
data neighborhood	Bairro	String
data city	Cidade	String
data postcode	Cep do afiliado	String
data zone_id	ID do estado, conferir tabela de estados	Int
data affiliate_parent_id	ID do afiliado Pai consultar o affiliate_id do pai e inserir o mesmo nesse campo, consulta feita a partir da rota https://api.irroba.com.br/v1/affiliate	Int
data comission	Comissão do afiliado	Decimal [0.00]
data cpf_cnpj	CPF ou CNPJ do afiliado	String
data bank_febraban_id	ID respectivo ao banco utilizado, consultar na tabela de bank_febraban	Int
data bank_branch_number	Agência	String
data bank_branch_number_dv	Dígito da Agência	String
data bank_account_name	Titular	String
data bank_account_number	Conta Corrente	String
data bank_account_number_dv	Dígito da Conta	String
data bank_account_operation	Operação	String
data pix_key	Chave PIX	String
data status	Status do afiliado	Int
data approved	Aprovação do afiliado	Int

{
    "firstname" : "Nome testefinal",
    "email" : "8irroba.irroba@irroba.com.br",
    "telephone" : "(99)9999-99999",
    "cellphone" : "(99)9999-99999",
    "password" : "teste123",
    "company" : "companhia",
    "website" : "https://integracoes.irroba.com.br/aps/index.php?",
    "address_1" : "Rua Nabi Haber",
    "address_2" : "casa de esquina",
    "number_home" : "465",
    "neighborhood" : "são josé",
    "city" : "Franca",
    "postcode" : "14401286",
    "zone_id" : 464,
    "affiliate_parent_id" : 18,
    "commission" : 10,
    "cpf_cnpj" : "59529730861",
    "bank_febraban_id" : 1,
    "bank_branch_number" : "0105",
    "bank_branch_number_dv" : "0",
    "bank_account_name" : "irroba teste",
    "bank_account_number" : "00012345",
    "bank_account_number_dv" : "0",
    "bank_account_operation" : "010",
    "pix_key" : "54818724475",
    "status" : 1,
    “approved” : 1
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "Affiliate successfully updated"
}

/deleteAffiliate

Método responsável por deletar um afiliado.

Deverá ser realizado uma requisição DELETE com a request necessária.

DELETE https://api.irroba.com.br/v1/deleteAffiliate

Requisição

Nome	Descrição	Formato
data	Objeto com todas informações do afiliado	Objeto em JSON
data email	Email do afiliado	String / Obrigatório

{
    "email": "arthur.depaula@irroba.com.br"
}

Resposta

Caso não ocorra nenhum problema, o método irá retornar o success como true.

Caso contrário, irá retornar success como false e também retornará a causa do problema.

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Mensagem de retorno da requisição	String

{
    "success": "true",
    "data": "affiliate successfully deleted"
}

Status

/status

Método responsável por retornar uma lista com o Nome e o ID de todos os status de uma determinada loja.

GET https://api.irroba.com.br/v1/status

Resposta

Caso não ocorra nenhum problema, os seguinte dados serão retornados:

Nome	Descrição	Formato
success	Retorno da requisição, "true" caso não haja nenhum problema	String
data	Objeto com todas as opções retornadas	Objeto em JSON
data order_status_id	ID do Status	Numérico (int)
data name	Nome do Status	String

{
    "success": "true",
    "data": [
        {
            "order_status_id": 3,
            "name": "Pedido em Transporte"
        },
        {
            "order_status_id": 5,
            "name": "Pagamento Aprovado"
        },
        {
            "order_status_id": 7,
            "name": "Pedido Cancelado"
        },
        {
            "order_status_id": 17,
            "name": "Aguardando Pagamento"
        },
        {
            "order_status_id": 20,
            "name": "Pedido Entregue"
        },
        {
            "order_status_id": 21,
            "name": "Pedido Negado"
        },
        {
            "order_status_id": 22,
            "name": "Pagamento em Análise"
        },
        {
            "order_status_id": 23,
            "name": "Emissão de Nota Fiscal"
        },
        {
            "order_status_id": 24,
            "name": "Substituição\/Análise Solicitada"
        },
        {
            "order_status_id": 25,
            "name": "Merc. para Substituição Recebida"
        },
        {
            "order_status_id": 26,
            "name": "Aguardando Merc. a ser Substituída"
        },
        {
            "order_status_id": 27,
            "name": "Preparando para Envio"
        },
        {
            "order_status_id": 28,
            "name": "Em produção"
        },
        {
            "order_status_id": 29,
            "name": "Aguardando Retirada na Loja"
        },
        {
            "order_status_id": 30,
            "name": "Pedido Devolvido"
        },
        {
            "order_status_id": 31,
            "name": "Merc. Perdida Fluxo Postal"
        },
        {
            "order_status_id": 32,
            "name": "Em processamento"
        },
        {
            "order_status_id": 33,
            "name": "Enviar agregado a outro pedido"
        },
        {
            "order_status_id": 34,
            "name": "Aguardando Retirada"
        },
        {
            "order_status_id": 35,
            "name": "Pedido Estornado"
        },
        {
            "order_status_id": 36,
            "name": "Pronto para Envio"
        },
        {
            "order_status_id": 37,
            "name": "Devolução recebida"
        },
        {
            "order_status_id": 38,
            "name": "Estorno Solicitado"
        },
        {
            "order_status_id": 41,
            "name": "Saiu para Entrega"
        },
        {
            "order_status_id": 42,
            "name": "Pedido Postado"
        },
        {
            "order_status_id": 43,
            "name": "Entrega não efetuada"
        }
    ]
}

Webhooks (Notificações)

Um Webhook é uma ferramenta que permite receber uma notificação para um determinado evento. Permite cadastrar uma URL https que receberá os dados do evento, armazenados em JSON. Os webhooks podem ser registrados para os seguintes eventos.

Categoria	Evento
Order (Pedido)	Criado / Atualizado
Product (Produto)	Criado / Atualizado

Para se inscrever em uma notificação, o lojista deve solicitar através de um ticket em nosso suporte informando o usuário da API e a URL do webhook.

Propriedades

Propriedades	Explicação
id	Identificador único do webhook. (Ex: No webhook de pedido, sera o ID do pedido)
event	Evento (order - para pedido, product - para produto)
operation	Operação (order_created_updated - para pedido, product_created_updated - para produto)
store_id	ID da loja na Irroba
urlNotifyService	URL do webhook cadastrado na Irroba
api_username	Usuário da API na Irroba
store_user	Prefixo do usuário da loja
is_mirrored	Indica se o pedido é espelhado ou não

Verificando um webhook

Os webhooks criados por meio da API podem ser verificados calculando uma assinatura digital. Cada solicitação de Webhook inclui um cabeçalho Authorization que é gerado usando um hash (SHA1) da senha do aplicativo, junto com os dados enviados na solicitação.

Exemplo de conteúdo de webhook de produto

{
    "id": 4360,
    "event": "product",
    "operation": "product_created_updated",
    "urlNotifyService": "https://webhook.site/58e58572-57e4-499c-9725-5c8f2ccfc642",
    "api_username": "totvsapi",
    "store_id": "123"
}

Exemplo de conteúdo de webhook de pedido

{
    "id": 14406,
    "event": "order",
    "operation": "order_created_updated",
    "urlNotifyService": "https://webhook.site/58e58572-57e4-499c-9725-5c8f2ccfc642",
    "api_username": "totvsapi",
    "store_user": "integri",
    "is_mirrored": false
}

Exemplo de conteúdo de webhook de carrinho abandonado

{
    "id": 567,
    "event": "abandoned_cart",
    "operation": "create",
    "urlNotifyService": "https://webhook.site/e6453770-ad1b-40d9-8ac0-90ec3a54facc",
    "api_username": "totvsapi",
    "store_user": "integri"
}

Políticas de repetição

Uma notificação de webhook espera um código de status 200 em resposta (tempo limite de 30 segundos). Se isso não acontecer (ele obtém outro código de resposta ou nenhuma resposta), tentaremos entregar a notificação novamente 4 vezes ao longo das próximas 4 horas em intervalos de tempo a cada 60 minutos. Depois disso, a notificação é perdida.