Referência da API

Esta referência auxilia na implementação da API V1 RESTful do Marketplace. Esta API utiliza o formato JSON para suas saídas. Esta API é stateless - totas as requisições são validadas utilizando o token da API. É possível encontrar instruções de como gerar o token na documentação sobre autenticação desta API.

Pedidos

Pedidos são registros de compras realizadas por compradores, requisitantes ou gestores na plataforma.

Obter todos os pedidos disponíveis

GET/pedidos

Lista todos os pedidos da empresa nas situações “Confirmado”, “Preparado”, “Faturado”, “Enviado” e “Entregue”.

Parâmetros
Não possui parâmetros de entrada

Obter pedidos confirmados

GET/pedidos/confirmados

Lista pedidos da empresa na situação “Confirmado”.

Parâmetros
Não possui parâmetros de entrada

Obter pedidos preparados

GET/pedidos/preparados

Lista pedidos da empresa na situação "Preparado".

Parâmetros
Não possui parâmetros de entrada

Obter pedidos faturados

GET/pedidos/faturados

Lista pedidos da empresa na situação "Faturado".

Parâmetros
Não possui parâmetros de entrada

Obter pedidos enviados

GET/pedidos/enviados

Lista pedidos da empresa na situação "Enviado".

Parâmetros
Não possui parâmetros de entrada

Obter pedidos entregues

GET/pedidos/entregues

Lista pedidos da empresa na situação "Entregue".

Parâmetros
Não possui parâmetros de entrada

Obter pedido por ID

GET/pedidos/{id}

Obtem pedidos através de seu ID

Parâmetros
id number	ID do pedido

Preparar pedido

PUT/pedidos/preparados/{id}

Altera situação de um pedido "Aprovado" para "Preparado".

Parâmetros
id number	ID do pedido

Faturar pedido

PUT/pedidos/faturados/{id}

Altera situação de um pedido "Preparado" para "Faturado".

Parâmetros
id number	ID do pedido

Enviar pedido

PUT/pedidos/enviados/{id}

Altera situação de um pedido "Faturado" para "Enviado".

Parâmetros
id number	ID do pedido

Receber pedido

PUT/pedidos/entregues/{id}

Altera situação de um pedido "Enviado" para "Entregue".

Parâmetros
id number	ID do pedido

Requisições

Requisições são registros de solicitação de produtos ainda não disponíveis para compra no Marketplace.

Modelos

Requisição

{
  "id": 1,
  "codigo": "1",
  "cliente": {
    "id": 1,
    "cnpj": "70.455.446/0001-96",
    "razaoSocial": "HS INTERMEDIACAO DE COMPRAS COLETIVAS E TECNOLOGICAS LTDA",
    "enderecos": [
      {
        "pais": "Brasil",
        "estado": "São Paulo",
        "cidade": "São Paulo",
        "bairro": "Bela Vista",
        "logradouro": "Av. Angélica",
        "cep": "01227-200",
        "numero": "2529",
        "tipo": 3
      }
    ]
  },
  "solicitante": {
    "id": 1,
    "nome": "John Doe",
    "email": "john.doe@smarkets.com.br"
  },
  "situacao": 2,
  "dataCriacao": "2019-01-01T00:00:00"
  "valor": 15.00
  "itens": [
    {
      "id": 1,
      "codigo": "1",
      "situacao": 2,
      "produto": {
        "id": 1,
        "codigo": "1",
        "descricao": "Caneta",
        "descricaoDetalhada": "Caneta esferográfica azul",
        "categoria": {
          "id": 1,
          "codigo": "1" 
          "descricao": "Escritório"
        },
        "unidadeMedida": {
          "id": 1,
          "codigo": "1",
          "descricao": "unidade"
        },
        "tipo": 1,
        "codigoNcm": "96081000"
      },
      "marca": {
        "id": 1,
        "codigo": "1",
        "descricao": "Bic"
      },
      "enderecoEntrega": {
        "pais": "Brasil",
        "estado": "São Paulo",
        "cidade": "São Paulo",
        "bairro": "Bela Vista",
        "logradouro": "Av. Angélica",
        "cep": "01227-200",
        "numero": "2529",
        "tipo": 3
      },
      "condicaoPagamento": {
        "id": 1,
        "codigo": "1",
        "descricao": "Pagamento em 30 dias"
      },
      "quantidade": 100,
      "moeda": 1,
      "valorReferencia": 0.15,
      "centroCusto": {
        "id": 1,
        "codigo": "1",
        "descricao": "Compras"
      }
    }
  ]
}

Item de requisição

{
  "id": 1,
  "codigo": "1",
  "situacao": 2,
  "produto": {
    "id": 1,
    "codigo": "1",
    "descricao": "Caneta",
    "descricaoDetalhada": "Caneta esferográfica azul",
    "categoria": {
      "id": 1,
      "codigo": "1" 
      "descricao": "Escritório"
    },
    "unidadeMedida": {
      "id": 1,
      "codigo": "1",
      "descricao": "unidade"
    },
    "tipo": 1,
    "codigoNcm": "96081000"
  },
  "marca": {
    "id": 1,
    "codigo": "1",
    "descricao": "Bic"
  },
  "enderecoEntrega": {
    "pais": "Brasil",
    "estado": "São Paulo",
    "cidade": "São Paulo",
    "bairro": "Bela Vista",
    "logradouro": "Av. Angélica",
    "cep": "01227-200",
    "numero": "2529",
    "tipo": 3
  },
  "condicaoPagamento": {
    "id": 1,
    "codigo": "1",
    "descricao": "Pagamento em 30 dias"
  },
  "quantidade": 100,
  "moeda": 1,
  "valorReferencia": 0.15,
  "centroCusto": {
    "id": 1,
    "codigo": "1",
    "descricao": "Compras"
  }
}

Obter todas as requisições disponíveis

GET/requisicoes

Lista todas as requisições da empresa nas situações "Confirmada", "Finalizada" e "Cancelada".

Parâmetros
Não possui parâmetros de entrada

Retorno
Retorna uma lista de requisições.

Obter requisição por ID

GET/requisicoes/{id}

Obtem requisições através de seu ID

Parâmetros
id number	ID da requisição

Retorno
Retorna uma Requisição

Obter todos os itens de requisições

GET/requisicoes/itens

Lista todos os itens de requisições da empresa nas situações "Em configuração", "Aguardando aprovação", "Recusado", "Aprovado", "Em cotação", "Finalizado" e "Cancelado".

Parâmetros
Não possui parâmetros de entrada

Retorno
Retorna uma lista de itens de requisição.

Criar requisições

POST/requisicoes/itens

Cria requisições a partir de itens enviados.

Parâmetros do body (campos marcados com * são obrigatórios)
codigo string	Código do item da requisição
codigoProduto* string	Código do produto
codigoMarca string	Código da marca
codigoEnderecoEntrega* string	Código do endereço de válido da empresa solicitante
codigoCondicaoPagamento number	Código da condição de pagamento
quantidade* number	Quantidade de itens solicitados
moeda* enum	Moeda utilizada. Opções: 1 = Real
valorReferencia number	Valor unitário para referência.
dataEntrega* date	Data de entrega esperada. Formato: YYYY-MM-DDThh:mm:ss
codigoCentroCusto* number	Código do centro de custo

Retorno
Retorna uma lista de requisições criadas.

Alterar item de requisição

PUT/requisicoes/itens/{id}

Altera dados de um item de requisição, desde que esteja entre as situações "Em configuração", "Recusado" ou "Aprovado"

Parâmetros do body (campos marcados com * são obrigatórios)
id* number	ID do item da requisição no Marketplace
codigo string	Código do item da requisição
codigoMarca string	Código da marca
codigoEnderecoEntrega* string	Código do endereço de válido da empresa solicitante
codigoCondicaoPagamento number	Código da condição de pagamento
quantidade* number	Quantidade de itens solicitados
moeda* enum	Moeda utilizada. Opções: 1 = Real
valorReferencia number	Valor unitário para referência.
dataEntrega* date	Data de entrega esperada. Formato: YYYY-MM-DDThh:mm:ss
codigoCentroCusto* number	Código do centro de custo

Retorno
Retorna item de requisição alterado.

Cancelar item de requisição

PUT/requisicoes/itens/{id}/cancelados

Altera situação de um item de requisição para "Cancelado" desde de que este esteja entre as situações "Aguardando aprovação", "Em configuração", "Aprovado" ou "Recusado"

Parâmetros
id number	ID da requisição item

Retorno
Retorna o item de requisição cancelado.