Última atualização: 17/04/2020 - v1.4.4

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 contato por email através de bruno@irroba.com.br ou equipe@irroba.com.br


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 paramêtro 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"
      }
    }
                                        

    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
    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
    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 cateogira, usado principalmente para motores de busca String
    data
    category_description
    meta_description
    Meta Descrição da cateogira, usado principalmente para motores de busca String
    data
    category_description
    meta_keyword
    Meta Keywords da cateogira, 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": "",
                "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 é 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)
    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.

  • 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)
    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
      },
      "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

    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
    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 String / Obrigatório / Máximo de 128 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
    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
    cellphone
    Celular do cliente String / Obrigatório / Máximo de 32 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 /
    {
      "type_person": "F",
      "firstname": "Teste API",
      "email": "api@irroba.com.br",
      "cpf_cnpj": "43919978***",
      "birthday": "1995-09-04",
      "sex": "M",
      "cellphone": "(16)993118372",
      "address": [
        {
          "firstname": "Teste API",
          "address_1": "Rua Nabi Haber",
          "number_home": "465",
          "neighborhood": "São José",
          "city": "Franca",
          "postcode": "14401220",
        }
      ]
    }
    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/{{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/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/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
    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,
                "customer_group_description": [
                    {
                        "name": "Representante",
                        "description": "Representante"
                    }
                ]
            },
            {
                "customer_group_id": 111,
                "sort_order": 0,
                "customer_group_description": [
                    {
                        "name": "CNPJ MEI",
                        "description": "CNPJ MEI"
                    }
                ]
            },
            {
                "customer_group_id": 110,
                "sort_order": 0,
                "customer_group_description": [
                    {
                        "name": "Vendedor",
                        "description": "Vendedor"
                    }
                ]
            },
            {
                "customer_group_id": 100,
                "sort_order": 0,
                "customer_group_description": [
                    {
                        "name": "Transportadora",
                        "description": "Transportadora"
                    }
                ]
            },
            {
                "customer_group_id": 90,
                "sort_order": 0,
                "customer_group_description": [
                    {
                        "name": "Fornecedor",
                        "description": "Fornecedor"
                    }
                ]
            },
            {
                "customer_group_id": 8,
                "sort_order": 0,
                "customer_group_description": [
                    {
                        "name": "Default",
                        "description": ""
                    }
                ]
            }
        ]
    }

    /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) 9999-99999",
        "mobile_operator": "",
        "cpf_cnpj": "999.999.999-99",
        "rg_ie": "",
        "address_id": 2181
      }
    }

    Manufacturers (Fabricantes)

    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 é 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)
    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!"
    }

    Marketing

    /coupon

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

    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 - Procentagem / 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)
    free_shipping Oferecer frete grátis (1 = Oferecer / 0 = Não oferecer) Numérico (int)
    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 teste API",
            "code": "testeapi123",
            "type": "P",
            "discount": 10,
            "total": 300.00,
            "free_shipping": 0,
            "date_start": "2019-09-12",
            "date_end": "2019-09-20",
            "uses_total": 10,
            "uses_customer": 2,
            "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
    {
      "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"
                    },
                    {
                        "option_value_id": 17387,
                        "option_id": 49,
                        "sort_order": 2,
                        "name": "Medio"
                    },
                    {
                        "option_value_id": 17385,
                        "option_id": 49,
                        "sort_order": 3,
                        "name": "Grande"
                    }
                ]
            },
            {
                "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"
                    },
                    {
                        "option_value_id": 324,
                        "option_id": 34,
                        "sort_order": 35,
                        "name": "Branco"
                    },
                    {
                        "option_value_id": 325,
                        "option_id": 34,
                        "sort_order": 36,
                        "name": "Verde claro"
                    }
                ]
            }
        ]
    }

    /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)

    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
    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

    /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 Numérico (float)
    data
    cost_price
    Preço de custo do produto Numérico (float)
    data
    weight
    Peso Numérico (float)
    data
    length
    Comprimento Numérico (float)
    data
    width
    Largura Numérico (float)
    data
    height
    Altura Numérico (float)
    data
    sku
    Muitas vezes utilizado como EAN / Código de barras 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
    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
    price
    Indica se tem uma alteração no preço original do produto (Irá somar ou subtrarir 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 subtrarir 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
    {
        "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",
                "weight": "3.0000",
                "length": "0.0000",
                "width": "0.0000",
                "height": "0.0000",
                "sku": "7909159650921",
                "status": 0,
                "date_added": "2017-06-06 15:46:24",
                "date_modified": "2017-06-19 15:57:40",
                "user_log": "murilo-irroba",
                "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": "Departamento 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/{{id}}

    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 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
    price
    Preço do produto Numérico (float)
    data
    cost_price
    Preço de custo do produto Numérico (float)
    data
    weight
    Peso Numérico (float)
    data
    length
    Comprimento Numérico (float)
    data
    width
    Largura Numérico (float)
    data
    height
    Altura Numérico (float)
    data
    sku
    Muitas vezes utilizado como EAN / Código de barras 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
    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
    price
    Indica se tem uma alteração no preço original do produto (Irá somar ou subtrarir 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 subtrarir 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
    {
        "success": "true",
        "data": [
            {
                "product_id": 48,
                "model": "0801",
                "image": "",
                "manufacturer_id": 0,
                "price": "1138.75",
                "cost_price": "0.00",
                "weight": "3.0000",
                "length": "0.0000",
                "width": "0.0000",
                "height": "0.0000",
                "sku": "7909159650921",
                "status": 0,
                "date_added": "2017-06-06 15:46:24",
                "date_modified": "2017-06-19 15:57:40",
                "user_log": "murilo-irroba",
                "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": "Departamento 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"
                            },
                            {
                                "option_value_id": 124,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "48"
                            },
                            {
                                "option_value_id": 51,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "35"
                            },
                            {
                                "option_value_id": 49,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "33"
                            },
                            {
                                "option_value_id": 50,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "34"
                            },
                            {
                                "option_value_id": 123,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "47"
                            },
                            {
                                "option_value_id": 122,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "46"
                            },
                            {
                                "option_value_id": 121,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "45"
                            },
                            {
                                "option_value_id": 120,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "44"
                            },
                            {
                                "option_value_id": 119,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "43"
                            },
                            {
                                "option_value_id": 118,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "42"
                            },
                            {
                                "option_value_id": 117,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "41"
                            },
                            {
                                "option_value_id": 116,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "40"
                            },
                            {
                                "option_value_id": 115,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "39"
                            },
                            {
                                "option_value_id": 114,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "38"
                            },
                            {
                                "option_value_id": 113,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "37"
                            },
                            {
                                "option_value_id": 52,
                                "quantity": 1,
                                "price": "0.00",
                                "price_prefix": "+",
                                "weight": "0.0000",
                                "weight_prefix": "+",
                                "name": "36"
                            }
                        ]
                    }
                ]
            }
        ]
    }

    /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
    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 subtrarir 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 subtrarir 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",
                        "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

    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
    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)
    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
    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
    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 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_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
    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_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)
    {
        "model" : "ABC12345",
        "price" : "1.200,00",
        "status": 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,
        "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,
                "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,
                "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"
            }
        ]
    }
    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.

    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
    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
    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 String
    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
    {
        "model" : "ABC12345",
        "sku" : "12344477886",
        "price" : "1.200,00",
        "status": 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,
        "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
            }
        ]
    }
    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: Toda vez que utilizar este método deve-se enviar todas as opções de estoques do produto novamente, pois o mesmo remove todas opções existentes e cadastra somente as opções enviadas no corpo da requisição

    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 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
    {
        "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/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.

  • 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.

  • 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.

    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": 10.00,
        "cost": 5.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": "Price updated successfully!"
    }

    /product/{{id}}

    Método responsável por deletar um Produto.

    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!"
    }

    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
    mercaOrderId ID do pedido dentro do MercadoLivre
    cnovaOrderId ID do pedido dentro do Cnova
    gfgOrderId ID do pedido dentro do GFG (Dafiti)
    netshoesOrderId ID do pedido dentro do Netshoes
    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

    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
    31 Pedido devolvido

    /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.

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

    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 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
    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
    {
      "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/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)
    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}}

    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)
    data Objeto com todos os pedidos retornados Objeto em JSON
    data
    order_id
    ID do pedido Numérico (int)
    data
    mercaOrderId
    ID do pedido dentro do MercadoLivre Numérico (int)
    data
    cnovaOrderId
    ID do pedido dentro do Cnova Numérico (int)
    data
    gfgOrderId
    ID do pedido dentro do GFG (Dafiti) Numérico (int)
    data
    netshoesOrderId
    ID do pedido dentro da Netshoes Numérico (int)
    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
    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
    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
    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
    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_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)
    {
      "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,
            "mercaOrderId": null,
            "cnovaOrderId": null,
            "gfgOrderId": 0,
            "netshoesOrderId": 0,
            "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_lastname": "Dude",
            "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_code": "sedex.sedex",
            "shipping_delivery_time": 5,
            "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,
            "user_seller": "Seller Test",
            "user_seller_id": 1,
            "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",
                "options": [
                    {
                        "order_option_id": 1515,
                        "product_option_id": 832,
                        "product_option_value_id": 13372,
                        "name": "Tamanho",
                        "value": "Único",
                        "option_value": {
                            "option_value_id": 255,
                            "quantity": 99,
                            "price": "0.00",
                            "price_prefix": "+",
                            "weight": "0.0000",
                            "weight_prefix": "+",
                            "reference": "",
                            "name": "Único"
                        }
                    },
                    {
                        "order_option_id": 1516,
                        "product_option_id": 833,
                        "product_option_value_id": 0,
                        "name": "Arquivo",
                        "value": "109f38c25c958eb40df7cfec336f1e50d40292ed",
                        "option_value": null
                    }
                ],
                "dimensions": {
                    "weight_class_id": 1,
                    "weight": "0.3000",
                    "length": "0.0000",
                    "width": "0.0000",
                    "height": "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}}

    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
    order_id
    ID do pedido Numérico (int)
    data
    mercaOrderId
    ID do pedido dentro do MercadoLivre Numérico (int)
    data
    cnovaOrderId
    ID do pedido dentro do Cnova Numérico (int)
    data
    gfgOrderId
    ID do pedido dentro do GFG (Dafiti) Numérico (int)
    data
    netshoesOrderId
    ID do pedido dentro da Netshoes Numérico (int)
    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
    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
    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
    melhor_envio_service
    ID da forma de envio na Melhor envio. (Somente sera exibido caso a forma de envio do pedido for Melhor envio). Numérico (int)
    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
    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
    number_of_installments
    Quantidade de parcelas Numérico (int)
    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
    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
    gift
    Objeto que contém os brindes no pedido (JSON somente será exibido caso o pedido possuir algum brinde) Objeto em JSON
    data
    gift
    product_id
    ID do produto brinde no pedido Numérico (int)
    data
    gift
    name/model
    Nome - Código do produto de brinde 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)
    {
      "success": "true",
      "data": {
        "order_id": 9115,
        "mercaOrderId": null,
        "cnovaOrderId": null,
        "gfgOrderId": 0,
        "netshoesOrderId": 0,
        "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": true,
        "user_seller": "Seller Test 1",
        "user_seller_id": 1,
        "customer_group_name": "Default",
        "number_of_installments": 1,
        "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",
            "stock_type": "2"
          }
        ],
        "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/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
    mercaOrderId
    ID do pedido dentro do MercadoLivre Numérico (int)
    data
    cnovaOrderId
    ID do pedido dentro do Cnova Numérico (int)
    data
    gfgOrderId
    ID do pedido dentro do GFG (Dafiti) Numérico (int)
    data
    netshoesOrderId
    ID do pedido dentro da Netshoes Numérico (int)
    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,
        "mercaOrderId": null,
        "cnovaOrderId": null,
        "gfgOrderId": 0,
        "netshoesOrderId": 0,
        "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
    xml XML da nota fiscal String / Obrigatório
    {
        "key": "99000099949900000999900000000099999999999999",
        "number": "1000",
        "cnpj": "99999999999990",
        "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
    model / product_id
    Código do produto String
    data
    order_product
    product_option_value_id
    ID da opção de estoque vendido Numérico (int)
    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",
            "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": [
            {
            "model": "abc1244",
            "product_option_value_id": 12115,
            "quantity": 1
            },
            {
            "product_id": "0",
            "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!"
    }