Versão 1
Versão 2
Versão 3
ProdutoLoja: Recurso para obter os dados do produto na loja
GET
v1/produtoLoja/ListaProduto/{status}
Lista todos os produtos

Notas:

Recupera uma lista de produtos existentes na loja.

Parâmetros de Entrada:

- status: (string) (não obrigatorio)
Caso não preenchido o sistema retornará todos os produtos ativos e inativos. Usar A para retornar somente os produtos ativos e I para inativos.

Parâmetros de Retorno:

Produto:
- codigoAgrupador: (integer)
Código de agrupação de variações de cor, voltagem, sabor e tamanho.

- titulo: (string)
Titulo do produto.

- sku: (integer)
Código do produto.

- gradex: (integer)
Código da variação de cor.

- gradey: (integer)
Código da variação que pode ser de voltagem, tamanho ou sabor.

- status: (string)
Situação do produto: A = Ativo e I = Inativo

Dados de Entrada:

Exemplos:
produtoLoja/ListaProduto/ativo
produtoLoja/ListaProduto/inativo

Dados JSON de Retorno:

{
   "produto": [
       {
         "codigoAgrupador": 0,
         "titulo": "string",
       "sku": 0,
         "gradex": 0,
      "gradey": 0,
      "status": "string"
    }
       ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/ProdutoSku/{sku}
Retorna Informações Detalhada do Produto por SKU

Notas:

Retorna ficha detalhadas do produto, consulta por sku.

Parâmetros de Entrada:

sku: (integer) (obrigatorio)
Informar o código do sku para consulta

Parâmetros de Retorno:

produto:
- codigoAgrupador: (integer)
Código de agrupação de variações de cor, voltagem, sabor e tamanho.

- titulo: (string)
Titulo do produto.

- descricao: (string)
Descrição detalhada do produto.

- peso: (numeric)
Peso bruto do produto em quilos

- cubagem: (numeric)
Cubagem da caixa do produto em metros cúbicos.

- peso: (numeric)
Peso bruto do produto em quilos

- volumes: (integer)
Quantidade de volumes/caixa que o produto possui

- modelo: (string)
Modelo do produto.

- prazoadicionaldeentrega: (integer)
Prazo adicional que o produto precisa para ser enviado a cliente.

- marca: (string)
Marca do produto

- garantia: (integer)
Garantia do produto em meses.

- NCM: (string)
Nomenclatura Comum do Mercosul

- altura_cm/ largura_cm/ profundidade_cm: (numeric)
Dimensões do produto embalado em centímetros.

- categoria: (string)
Categoria principal do produto.

- subcategoria: (string)
Categoria final do produto.

atributos: (array)
- sku: (integer)
Código sku do produto

- ean: (string)
Código de barras comercial único do produto.


- codigogradex: (integer)
Código identificador da cor

- tipogradex: (string)
Nome da Cor

- nomegradex: (string)
Nome identificador da cor

- codigogradey: (integer)
Nome identificador da opção: voltagem, tamanho, sabor, etc

- tipogradey: (string)
Nome da variação: voltagem, tamanho, sabor, etc

- nomegradey: (string)
Nome identificador do tipo a ser escolhido

- status: (string)
Situação do produto A = Ativo | I = Inativo

- fotoprincipal: (string)
URL da foto principal do produto

fotosadicional: (array)
- foto: (string)
URLs contendo as fotos de detalhes.

Dados de Entrada:

produtoLoja/ProdutoSku/{sku}

Dados JSON de Retorno:

{
   "produto":
   {
      "codigoAgrupador": 0,
      "titulo": "string",
      "descricao": "string",
      "peso": 0,
      "cubagem": 0,
      "volumes": 0,
      "modelo": "string",
      "prazoadicionaldeentrega": 0,
      "marca": "string",
      "garantia": 0,
      "NCM": "string",
      "altura_cm": 0,
      "largura_cm": 0,
      "profundidade_cm": 0,
      "categoria": "string",
      "subcategoria": "string",
      "atributos":[
                     {
                        "sku": 0,
                        "ean": "string",
                        "codigogradex": 0,
                        "tipogradex": "string",
                        "nomegradex": "string",
                        "codigogradey": 0,
                        "tipogradey": "string",
                        "nomegradey": "string",
                        "status": "string",
                        "fotoprincipal": "string",
                        "fotosadicional": [{"foto": "string"}]
                        }
   }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/CodigoAgrupador/{codigoAgrupador}
Retorna Inf. Detalhada do Produto por Código Agrupador

Notas:

Retorna ficha detalhadas do produto, consulta por código agrupador.

Parâmetros de Entrada:

codigo: (integer) (obrigatorio)
Informar o código agrupador para consulta

Parâmetros de Retorno:

produto:
- codigoAgrupador: (integer)
Código de agrupação de variações de cor, voltagem, sabor e tamanho.

- titulo: (string)
Titulo do produto.

- descricao: (string)
Descrição detalhada do produto.

- peso: (numeric)
Peso bruto do produto em quilos

- cubagem: (numeric)
Cubagem da caixa do produto em metros cúbicos.

- peso: (numeric)
Peso bruto do produto em quilos

- volumes: (integer)
Quantidade de volumes/caixa que o produto possui

- modelo: (string)
Modelo do produto.

- prazoadicionaldeentrega: (integer)
Prazo adicional que o produto precisa para ser enviado a cliente.

- marca: (string)
Marca do produto

- garantia: (integer)
Garantia do produto em meses.

- NCM: (string)
Nomenclatura Comum do Mercosul

- altura_cm/ largura_cm/ profundidade_cm: (numeric)
Dimensões do produto embalado em centímetros.

- categoria: (string)
Categoria principal do produto.

- subcategoria: (string)
Categoria final do produto.

atributos: (array)
- sku: (integer)
Código sku do produto

- ean: (string)
Código de barras comercial único do produto.


- codigogradex: (integer)
Código identificador da cor

- tipogradex: (string)
Nome da Cor

- nomegradex: (string)
Nome identificador da cor

- codigogradey: (integer)
Nome identificador da opção: voltagem, tamanho, sabor, etc

- tipogradey: (string)
Nome da variação: voltagem, tamanho, sabor, etc

- nomegradey: (string)
Nome identificador do tipo a ser escolhido

- status: (string)
Situação do produto A = Ativo | I = Inativo

- fotoprincipal: (string)
URL da foto principal do produto

fotosadicional: (array)
- foto: (string)
URLs contendo as fotos de detalhes.

Dados de Entrada:

produtoLoja/CodigoAgrupador/{codigoAgrupador}

Dados JSON de Retorno:

{
   "produto":
   {
      "codigoAgrupador": 0,
      "titulo": "string",
      "descricao": "string",
      "peso": 0,
      "cubagem": 0,
      "volumes": 0,
      "modelo": "string",
      "prazoadicionaldeentrega": 0,
      "marca": "string",
      "garantia": 0,
      "NCM": "string",
      "altura_cm": 0,
      "largura_cm": 0,
      "profundidade_cm": 0,
      "categoria": "string",
      "subcategoria": "string",
      "atributos":[
                     {
                        "sku": 0,
                        "ean": "string",
                        "codigogradex": 0,
                        "tipogradex": "string",
                        "nomegradex": "string",
                        "codigogradey": 0,
                        "tipogradey": "string",
                        "nomegradey": "string",
                        "status": "string",
                        "fotoprincipal": "string",
                        "fotosadicional": [{"foto": "string"}]
                        }
   }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/saldo/full
Lista Saldo de Todos os Produtos

Notas:

Retorna o Saldo disponível de todos os produtos.

Parâmetros de Entrada:

vazio

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- saldo: (integer)
Saldo disponível.

Dados de Entrada:

vazio

Dados JSON de Retorno:

{
"produto":[
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "saldo": 0
            },
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "saldo": 0
            }
      ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/saldo/sku/{sku}
Retorna Saldo do Produto por SKU

Notas:

Retorna o Saldo disponível de um produto, consulta por SKU.

Parâmetros de Entrada:

sku: (integer) (obrigatorio)
Informar o código do sku para consulta

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- saldo: (integer)
Saldo disponível.

Dados de Entrada:

saldo/sku/{sku}

Dados JSON de Retorno:

{
"produto":[
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "saldo": 0
            },
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "saldo": 0
            }
      ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/saldo/codigoAgrupador/{codigoAgrupador}
Retorna Saldo do Produto por Código Agrupador e Grade

Notas:

Retorna o Saldo disponível de um produto, consulta por Código Agrupador com ou sem Grades.

Parâmetros de Entrada:

codigo: (integer) (obrigatorio)
Código do agrupador

gradex: (integer) (não obrigatorio)
Código da cor

gradey: (integer) (não obrigatorio)
Código da voltagem, tamanho ou sabor.

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- saldo: (integer)
Saldo disponível.

Dados de Entrada:

saldo/codigoAgrupador/{codigoAgrupador}

Dados JSON de Retorno:

{
"produto":[
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "saldo": 0
            },
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "saldo": 0
            }
      ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/preco/full/{limite}/{posicao}
Lista Preço de Todos os Produtos

Notas:

Retorna o Preço de Venda de todos os produtos.

Parâmetros de Entrada:

- limite: (integer) (não obrigatório)
É a quantidade de registros a serem retornados por chamada.

- posicao: (integer) (não obrigatório)
É a posição do registro, ou seja, a sequencia do registro na chamada.

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- precode: (numeric)
Preço de, ou seja, o preço anterior.

- precopor: (numeric)
Preço de Venda.

Dados de Entrada:

/preco/full/{limite}/{posicao}

Dados JSON de Retorno:

{
"produto":[
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "precode": 0,
               "precopor": 0
            },
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "precode": 0,
               "precopor": 0
            }
      ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/preco/sku/{sku}
Retorna Preço do Produto Por SKU

Notas:

Retorna o Preço de um produto, consulta por SKU.

Parâmetros de Entrada:

sku: (integer) (obrigatorio)
Informar o código do sku para consulta

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- precode: (numeric)
Preço de, ou seja, o preço anterior.

- precopor: (numeric)
Preço de Venda.

Dados de Entrada:

produtoLoja/preco/sku/{sku}

Dados JSON de Retorno:

{
"produto":[
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "precode": 0,
               "precopor": 0
            },
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "precode": 0,
               "precopor": 0
            }
      ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/preco/codigoAgrupador/{codigoAgrupador}
Retorna Preço do Produto por Código Agrupador e Grade

Notas:

Retorna o Preço de um produto, consulta por Código Agrupador

Parâmetros de Entrada:

codigo: (integer) (obrigatorio)
Código do agrupador

gradex: (integer) (não obrigatorio)
Código da cor

gradey: (integer) (não obrigatorio)
Código da voltagem, tamanho ou sabor.

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- precode: (numeric)
Preço de, ou seja, o preço anterior.

- precopor: (numeric)
Preço de Venda.

Dados de Entrada:

/preco/CodigoAgrupador/{codigo}
ou
/preco/CodigoAgrupador/{codigo}/{gradex}/{gradey}

Dados JSON de Retorno:

{
"produto":[
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "precode": 0,
               "precopor": 0
            },
            {
               "sku": 0,
               "codigoAgrupador": 0,
               "gradex": 0,
               "gradey": 0,
               "precode": 0,
               "precopor": 0
            }
      ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/ofertasmarketplaces
Ofertas marketplaces

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

produto:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- precode: (numeric)
Preço de, ou seja, o preço anterior.

- precopor: (numeric)
Preço de Venda.

ofertamarkeplacecodigopai:

- markeplace: (string)

- datainicio: (string)

- horainicio: (string)

- datafim: (string)

- horafim: (string)

- valor: (numeric)

- percentualnegociacao: (string)

- percentualcategoria: "não/sim"

- saldolimite: (integer)

- vpc: (numeric)

- usuario: (string)

- datacadastro: (string)

ofertamarkeplacesku:

- sku: (integer)

- gradex: (integer)
Grade de variação de cor.

- gradey: (integer)
Grade de variação de voltagem, tamanho ou sabor.

- markeplace: (string)

- datainicio: (string)

- horainicio: (string)

- datafim: (string)

- horafim: (string)

- valor: (numeric)

- percentualnegociacao: (integer)

- percentualcategoria: "não/sim"

- saldolimite: (integer)

- vpc: (numeric)

- usuario: (string)

- datacadastro: (string)

Dados de Entrada:

produtoLoja/ofertasmarketplaces

Dados JSON de Retorno:

{
   "produto": [{
      "sku": 0,
      "IdReferencia": "0",
      "codigoAgrupador": 0,
      "precodePadrao": 0,
      "precoporPadrao": 0,
      "ofertamarkeplacecodigopai": [{
         "markeplace": "string",
         "datainicio": "string",
         "horainicio": "00:00",
         "datafim": "string",
         "horafim": "00:00",
         "valor": 0.00,
         "percentualnegociacao": "0.00",
         "percentualcategoria": "não",
         "saldolimite": 0,
         "vpc": 0.00,
         "usuario": "string",
         "datacadastro": "string"
      }],
      "ofertamarkeplacesku": [{
         "sku": 0,
         "gradex": 0,
         "gradey": 0,
      
   "markeplace": "string",
         "datainicio": "string",
         "horainicio": "00:00",
         "datafim": "string",
         "horafim": "00:00",
         "valor": 0,
         "percentualnegociacao": 0,
         "percentualcategoria": "não/sim",
         "saldolimite": 0,
         "vpc": 0.00,
         "usuario": "string",
         "datacadastro": "string"
      }]
   }]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/produtoLoja/ofertasfretemarketplaces
Ofertas Frete Marketplaces

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

- marketPlace: (string)
Nome do MarketPlace.

- produto: (integer)
Código do produto.

- cepinicial: (integer)

- cepfinal: (integer)

- valorDesconto: (numeric)
desconto frete

- prazoEntrega: (integer)
Prazo de Entrega em dias.

- usuario: (string)
Nome do Usuario

- datacadastro: (string)
data de cadastro.

Dados de Entrada:

produtoLoja/ofertasfretemarketplaces

Dados JSON de Retorno:

{
"markeplace": "string",
"produto":"string",
"datainicio": "string",
"datafim": "string",
"cepInicial": "00000000",
"cepInicial": "99999999"
"valorDesconto": "0",
"prazoEntrega": "0",
"usuario": "string",
"datacadastro": "string"   
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/produtoLoja/saldo
Atualiza Saldo Disponivel e Real

Notas:

Recurso para atualizar o estoque do produto.

Parâmetros de Entrada:

IdReferencia: (string) (obrigatorio caso não seja informado o sku ou codAgrupador)
Código de referencia do produto, o mesmo utilizado no ERP cliente.

codAgrupador: (integer) (obrigatorio caso não seja informado, sku ou IdReferencia)
Código pai do produto.

gradex e gradey: (integer) (obrigatorio somente quando utilizado codigo pai)
É a grade de cores, tamanho, sabor e voltagem.
sku: (integer) (obrigatorio caso não seja informado o sku ou IdReferencia)
Código sku do produto

filialSaldo: (integer) (obrigatorio)
Informar o codigo da FL, utilizar 1 caso utilize somente uma filial.

saldoReal: (integer) (obrigatorio)
Informar o saldo real em estoque.

saldoDisponivel: (integer) (obrigatorio)
Informar o saldo que será disponibilizado para venda.

Saldo real em estoque: é o saldo físico que a loja tem do produto. Se informado zera o prazo adicional de entrega (crosdoking).
O saldo disponível de venda: é o saldo que a loja quer disponibilizar ao cliente para compra.

Parâmetros de Retorno:

IdReferencia: (string)
Código de referencia do produto, o mesmo utilizado no ERP cliente.

sku: (integer)
Código sku do produto

idMensagem: (integer) (obrigatorio)
Código do retorno. Zero para sucesso.

mensagem: (integer) (obrigatorio)
Descrição da mensagem.

Dados de Entrada:

{
   "produto":
   [
      {
         "IdReferencia": "",
         "sku": 0,
         "estoque":
         [
            {
               "filialSaldo": 0,
               "saldoReal": 0,
               "saldoDisponivel": 0
            }
         ]
      }
   ]
}

Dados JSON de Retorno:

{
   "produto":
   [
      {
         "IdReferencia": "",
         "codAgrupador": 0, "gradex": 0, "gradey": 0,
         "sku": 0,
         "idMensagem": "",
         "mensagem": ""
      }
   ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/produtoLoja/preco
Atualiza Preço de Venda

Notas:

Serviço para atualização de Preço.

Parâmetros de Entrada:

IdReferencia: (string) (obrigatorio caso não seja informado o sku)
Código de referencia do produto, o mesmo utilizado no ERP cliente.

sku: (integer) (obrigatorio caso não seja informado o IdReferencia)
Código sku do produto

codAgrupador: (string) (obrigatorio caso não seja informado, sku ou IdReferencia)
Código pai do produto.

precoDe: (numeric)
Preço de apresentação. Exemplo De R$99,00 por R$89,00

precoVenda: (numeric) (obrigatorio)
Preço Padrão de venda.

precoSite: (numeric)
Preço de venda no site, caso não informado o preço site será o precoVenda.

Parâmetros de Retorno:

IdReferencia: (string)
Código de referencia do produto, o mesmo utilizado no ERP cliente.

sku: (integer)
Código sku do produto

idMensagem: (integer) (obrigatorio)
Código do retorno. Zero para sucesso.

mensagem: (integer) (obrigatorio)
Descrição da mensagem.

Dados de Entrada:

{
   "produto":
   [
      {
         "IdReferencia": "",
         "sku": 0,
         "precoDe": 0,
         "precoVenda": 0,
         "precoSite": 0
      }
   ]
}

Dados JSON de Retorno:

{
   "produto":
   [
      {
         "IdReferencia": "",
         "codAgrupador": "",
         "sku": 0,
         "idMensagem": "",
         "mensagem": ""
      }
   ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Frete: Recurso para obter a simulação de frete
GET
v1/frete/unico
Retorna Simulação de Frete. (Total Unificado)

Notas:

Retorna a simulção de frete. Valor, Prazo de entrega e outras informações.
O Retorno da simulação será um valor unico total, independente da quantidade de produtos simulados.

Parâmetros de Entrada:

- cep: (integer) (obrigatório)
CEP do destino.

- tipoConsulta: (string) (obrigatório)
Tipo de consulta de produto que pode ser sku ou código (Código Agrupador)

Produtos:
- id: (integer) (obrigatório)
Código do produto ou sku

- quantidade: (integer) (obrigatório)
Quantidade que está sendo comprada.

Parâmetros de Retorno:

frete:
- valorTotal: (numeric)
Valor total do frete.

- prazoEntrega: (integer)
Prazo de entrega em dias.

- codigoTransportadora: (integer)
Código do transportadora no sistema do lojista.

- filialSaldo: (integer)
Centro de distribuição onde o produto irá sair.

- filialSaldoUF: (string)
UF do Centro de distribuição onde o produto irá sair.

- filialFatura: (integer)
Número da Filial de faturamento

- filialFaturaUF: (string)
UF Número da de faturamento

- nomeTranspotadora: (string)
Nome da transportadora que realizará a entrega.

Dados de Entrada:

{
            "cep": 0
            "tipoConsulta": "sku ou codigo",
            "produtos": [
                         {
                         "id": 0,
                        "quantidade": 0
                        },
                        {
                         "id": 0,
                        "quantidade": 0
                        }
                     ]
}

Dados JSON de Retorno:

{
            "frete":{
                  "valorTotal": 0,
                  "prazoEntrega": 0,
                  "codigoTransportadora": 0,
                  "filialSaldo": 0,
                  "filialSaldoUF": "string",
                  "filialFatura": 0,
                  "filialFaturaUF": "string",
                  "nomeTranspotadora": "string"
               }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/frete/item
Retorna Simulação de Frete. (Valor do Frete por Produto)

Notas:

Retorna a simulção de frete. Valor, Prazo de entrega e outras informações.
O Retorno da simulação será por produto, ou seja, cada produto informado na consulta retornará seu dados de frete.

Parâmetros de Entrada:

- cep: (integer) (obrigatório)
CEP do destino.

- tipoConsulta: (string) (obrigatório)
Tipo de consulta de produto que pode ser sku ou código (Código Agrupador)

Produtos:
- id: (integer) (obrigatório)
Código do produto ou sku

- quantidade: (integer) (obrigatório)
Quantidade que está sendo comprada.

Parâmetros de Retorno:

frete:
- sku: (integer)
Código do produto.

- codigoAgrupador: (integer)
Código agrupador do produto.

- valorTotal: (numeric)
Valor total do frete.

- prazoEntrega: (integer)
Prazo de entrega em dias.

- codigoTransportadora: (integer)
Código do transportadora no sistema do lojista.

- filialSaldo: (integer)
Centro de distribuição onde o produto irá sair.

- filialSaldoUF: (string)
UF do Centro de distribuição onde o produto irá sair.

- filialFatura: (integer)
Número da Filial de faturamento

- filialFaturaUF: (string)
UF da Filial de faturamento

- nomeTranspotadora: (string)
Nome da transportadora que realizará a entrega.

Dados de Entrada:

{
            "cep": 0
            "tipoConsulta": "sku ou codigo",
            "produtos": [
                         {
                         "id": 0,
                        "quantidade": 0
                        },
                        {
                         "id": 0,
                        "quantidade": 0
                        }
                     ]
}

Dados JSON de Retorno:

{
   "frete":[
      {
         "sku": 0,
         "codigoAgrupador": 0,
          "valorTotal": 0,
         "prazoEntrega": 0,
         "codigoTransportadora": 0,
         "filialSaldo": 0,
         "filialSaldoUF": "string",
          "filialFatura": 0,
          "filialFaturaUF": "string",
          "nomeTranspotadora": "string"
       },
      {
          "sku": 0,
         "codigoAgrupador": 0,
         "valorTotal": 0,
         "prazoEntrega": 0,
          "codigoTransportadora": 0,
         "filialSaldo": 0,
         "filialFatura": 0,
         "nomeTranspotadora": "string"
      }
       ]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Pedido: Recurso para gerenciamento de pedidos marketplace
POST
v1/pedido/pedido
Recurso para criar um pedido novo.

Notas:

Operação que cria um pedido no Lojista.
Todo pedido gerado entrará com status novo. A alteração de status se dará no Pedido/GET caso o financeiro seja do parceiro ou no PedidoTransaciona/POST caso o financeiro seja do Lojista

Parâmetros de Entrada:

- idPedidoParceiro: (string) (obrigatório)
É o seu codigo de pedido.

- valorFrete: (numeric) (obrigatório)
Valor total do frete.

- prazoEntrega:(integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- valorTotalCompra: (numeric)
Valor total da compra. Soma entre o total de pedidos + total de itens. Caso seja seja enviado o sistema não irá realizar a validação.

- formaPagamento: (string) (obrigatório)
Forma de pagamento. Exemplo: visa, mastercard, dieners, boleto. Cada loja irá fornecer a lista das formas de pagamentos disponiveis.

- cpfCnpj: (string) (obrigatório)
CPF ou CNPJ do cliente

- nomeRazao: (string) (obrigatório)
Nome do cliente ou Razão social da empresa

- fantasia: (string) (obrigatório)
Apelido do cliente ou nome Fantasia da Loja

- sexo: (string) (opcional)
Usar M ou F

- dataNascimento: (string) (opcional)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy

- email: (string) (obrigatório)
E-mail do cliente.

- cep: (string) (obrigatório)
CEP do endereço de entrega

- numero: (string) (obrigatório)
Número da residência, caso não tenha enviar s/n

- bairro: (string) (obrigatório)
Bairro do endereço de entrega

- complemento: (string)
Complemento ou ponto de referência do endereço de entrega

- cidade: (string) (obrigatório)
Cidade do endereço de entrega

- uf: (string) (obrigatório)
Estado do endereço de entrega

- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal

- residencial: (string) (obrigatório)
Telefone residencial do cliente

- comercial: (string)
Telefone comercial caso tenha

- celular: (string) (obrigatório)
Telefone celular do cliente

Pagamento:
- valor: (numeric) (obrigatório)
Valor total do meio de pagamento.

- quantidadeParcelas: (integer) (obrigatório)
Quantidade de parcelas do meio de pagamento.

- meioPagamento: (string) (opcional)
Nome do meio do pagamento, exemplo: visa, master, boleto.

- autorizacao: (string) (opcional)
Número da autorização. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.

- nsu: (string) (opcional)
Número do NSU. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.

Itens:
- sku: (integer) (obrigatório)
Código SKU do produto

- valorUnitario: (numeric) (obrigatório)
Valor unitário do produto

- quantidade: (integer) (obrigatório)
Quantidade de itens comprado do sku

Parâmetros de Retorno:

- numeroPedido: (integer)
Número do pedido gerado pela loja

- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido

- mensagem: (string)
Mensagem de erro ou sucesso gerada pelo sistema. Em caso de sucesso será gerado o mensagem "sucesso" ou "pedido já gerado"

Dados de Entrada:

{
   "pedido":
   {
      "idPedidoParceiro": "string",
       "valorFrete": 0,
       "prazoEntrega": 0,
       "valorTotalCompra": 0,
       "formaPagamento": "string",
       "dadosCliente":
        {
            "cpfCnpj": "string",
            "nomeRazao": "string",
            "fantasia": "string",
            "sexo": "string",
            "dataNascimento": "string",
            "email": "string",
             "dadosEntrega":
             {
                  "cep": "string",
                  "endereco": "string",
                  "numero": "string",
                  "bairro": "string",
                  "complemento": "string",
                  "cidade": "string",
                  "uf": "string",
                  "responsavelRecebimento": "string"
            },
          "telefones":
          {
            "residencial": "string",
            "comercial": "string",
            "celular": "string"
         }
},
"pagamento": [
{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "string",
         "autorizacao": "string",
         "nsu": "string"
}],
"itens": [
{
         "sku": 0,
         "valorUnitario": 0,
         "quantidade": 0
}
]
}
}

Dados JSON de Retorno:

{
"pedido":{
       "numeroPedido": 0,
       "idPedidoParceiro": "string",
       "mensagem": "string"
    }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/pedido/pedido/{codigoPedido}
Recupera detalhes do pedido. Dados NF, Rastreio, etc.

Notas:

Recupera detalhes do pedido

Parâmetros de Entrada:

É obrigatório o envio do codigoPedido e/ou idPedidoParceiro

- codigoPedido: (integer)
É o seu codigo gerado pela loja no momento da criação do pedido.

- idPedidoParceiro: (string)
É o seu codigo de pedido.

Parâmetros de Retorno:

- idPedidoParceiro: (string)
É o seu codigo de pedido.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. Soma entre o total de pedidos + total de itens. Caso seja seja enviado o sistema não irá realizar a validação.

- valorTotalDesconto: (numeric)
Valor total de desconto na venda boleto.

- idAfiliado: (integer)
Código do afiliados, ou seja, do parceiro que efetuou a venda.

- nomeAfiliado (string)
Nome do afiliados, ou seja, do parceiro que efetuou a venda.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- cpfCnpj: (string)
CPF ou CNPJ do cliente

- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)

- nomeRazao: (string)
Nome do cliente ou Razão social da empresa

- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja

- sexo: (string)
Usar M ou F

- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy

- email: (string)
E-mail do cliente.

- cep: (string)
CEP do endereço de entrega

- numero: (string)
Número da residência, caso não tenha enviar s/n

- bairro: (string)
Bairro do endereço de entrega

- complemento: (string)
Complemento ou ponto de referência do endereço de entrega

- cidade: (string)
Cidade do endereço de entrega

- uf: (string)
Estado do endereço de entrega

- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal

- residencial: (string)
Telefone residencial do cliente

- comercial: (string)
Telefone comercial caso tenha

- celular: (string)
Telefone celular do cliente

Pagamento:

- valor: (numerica)
Valor total do meio de pagamento

- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento

- meioPagamento: (string)
Descrição do meio de pagamento

- autorizacao: (string)
Número da autorização do cartão de crédito.

- nsu: (string)
Número NSU do cartão de crédito.

Itens:

- sku: (integer)
Código SKU do produto

- descricaoProduto: (string)
Campo de referência da Descrição do produto

- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.

- valorUnitario: (numeric)
Valor unitário do produto

- quantidade: (integer)
Quantidade de itens comprado do sku


Dados Rastreio:

- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.

- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.

- dataFaturamento (string)
data da nota fiscal.

- idCentroDistribuicao (string)
Código do Centro de Distribuição

- cidadeDistribuicao (string)
Cidade onde o produto saiu

- ufCentroDistribuicao (string)
Estado onde o produto saiu

- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto

- urlRastreio (string)
URL de rastreio junto a transportadora

- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.


Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

api/v1/pedido/pedido/{codigoPedido}/{idPedidoParceiro}
ou
api/v1/pedido/pedido/{codigoPedido}/
ou
api/v1/pedido/pedido/0/{idPedidoParceiro}

Dados JSON de Retorno:

{
   "pedido":
   {
      "codigoPedido": 0,
      "idPedidoParceiro": "string",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "string",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "string",
      "statusAtual": "string",
      "dadosCliente":
       {
         "cpfCnpj": "string",
         "tipo": "string",
         "nomeRazao": "string",
         "fantasia": "string",
         "sexo": "string",
         "dataNascimento": "string",
         "email": "string",
         "dadosEntrega":
         {
               "cep": "string",
               "endereco": "string",
               "numero": "string",
               "bairro": "string",
               "complemento": "string",
               "cidade": "string",
               "uf": "string",
               "responsavelRecebimento": "string"
         },
         "telefones":
         {
            "residencial": "string",
            "descricaoProduto": "string",
            "descricaoOpcao": "string";
            "comercial": "string",
            "celular": "string"
         }
      },
      "pagamento": [
         {
            "valor": 0,
            "quantidadeParcelas": 0;
            "meioPagamento": "string";
            "autorizacao": "string";
            "nsu": "string"
         }
      ],
      "itens": [
         {
            "sku": 0,
            "descricaoProduto": "string";
            "descricaoOpcao": "string";
            "valorUnitario": 0,
            "quantidade": 0
         }
      ],
      "dadosRastreio":
       {
          "nomeroNotaFiscal": 0,
          "chaveNotaFiscal": "string",
          "dataFaturamento": "string",
          "idCentroDistribuicao": 0,
          "cidadeDistribuicao": "string",
          "ufCentroDistribuicao": "string",
          "idTransportadora": "0,
          "transportadora": "string",
          "urlRastreio": "string",
          "protocoloCorreios": "string"
       },
      "dadosAcompanhamento":
       [
          {
              "data": "string",
              "hora": "string",
              "descricao": "string"
           }
       }
   }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/pedido/pedidoStatus
Recupera lista de pedidos por data de status.

Notas:

Recupera lista de pedido por data de atualização de status

Parâmetros de Entrada:

- inicio: (string) (obrigatório)
Enviar data inicial no formato yyyy-mm-dd

- fim: (string) (obrigatório)
Enviar data final no formato yyyy-mm-dd

O periodo não pode ser superior a 31 dias

- inicio: (string)
Enviar hora inicial no formato HH:mm:ss

- fim: (string)
Enviar hora final no formato HH:mm:ss

Parâmetros de Retorno:

- numeroPedido: (integer)
Número do pedido gerado pela loja

- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- idStatusAtual(integer)
Código do status atual.

Dados de Entrada:

{
"data":{
      "inicio": string,
      "fim": "string"
},
"hora":{
      "inicio": string,
      "fim": "string"
}
}

Dados JSON de Retorno:

{
"pedido":[{
      "numeroPedido": 0,
      "idPedidoParceiro": "string",
      "statusAtual": "string",
      "idStatusAtual": 0
   }]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/pedido/cancelamento
Recupera lista de Pedidos com cancelamento

Notas:

Recupera uma lista de pedidos cancelados total ou parcialmente.

Parâmetros de Entrada:

- inicio: (string) (obrigatório)
Enviar data inicial no formato yyyy-mm-dd

- fim: (string) (obrigatório)
Enviar data final no formato yyyy-mm-dd

Parâmetros de Retorno:

Dados de Entrada:

{
"data":{
"inicio": string,
"fim": "string"
}
}

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "idPedidoParceiro": "string",
      "itensCancelados": [{
         "sku": 4104,
         "codigoPai": 0,
         "gradex": 0,
         "gradey": 0,
         "referenciaEmpresa": "string",
         "descricaoProduto": "string",
         "descricaoOpcao": "string",
         "valorUnitario": 0,
         "quantidadeVendido": 0,
         "quantidadeDevolvido": 0,
         "nbm": "string",
         "ean": "string",
         "volumes": 0,
         "peso": 0
      }]
   }]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/pedido/estorno/{data Inicial}/{data Final}
Recupera lista de Pedidos com Estorno de Credito

Notas:

Recupera uma lista de pedidos com estorno de credito

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

Dados JSON de Retorno:

{
"lista": [{
"pedidoSite": 0,
"pedidoMarketplace": "",
"cpfClinete": "",
"notaFiscal": 0,
"gatway": "",
"operadora": "",
"dataVenda": "",
"dataSolicitacaoEstorno": "",
"dataEstorno": "",
"autorizacao": "",
"autCC": "",
"nsu": "",
"nsuSitef": "",
"nsuHost": "",
"cartao": "",
"valorEstorno": 0,
"tipoEstorno": "",
"motivo": ""
}]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/pedido/pedido
Recurso para aprovar um pedido com status novo

Notas:

Operação para aprovar um pedido pendente.

Parâmetros de Entrada:

É obrigatório o envio do codigoPedido e/ou idPedidoParceiro

- codigoPedido: (integer)
É o seu codigo gerado pela loja no momento da criação do pedido.

- idPedidoParceiro: (string)
É o seu codigo de pedido.

Parâmetros de Retorno:

- numeroPedido: (integer)
Número do pedido gerado pelo sistema

- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido

- mensagem: (string)
Mensagem de erro ou sucesso gerada pelo sistema. Em caso de sucesso será gerado o mensagem "sucesso" ou "pedido já aprovado"

Dados de Entrada:

{
"pedido":{
      "codigoPedido": 0,
      "idPedidoParceiro": "string"
}
}

Dados JSON de Retorno:

{
"pedido":{
      "numeroPedido": 0,
      "idPedidoParceiro": "string",
      "mensagem": "string"
}
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
DELETE
v1/pedido/pedido
Recurso para cancelar um pedido com status novo

Notas:

Operação para cancelar um pedido pendente.

Parâmetros de Entrada:

É obrigatório o envio do codigoPedido e/ou idPedidoParceiro

- codigoPedido: (integer)
É o seu codigo gerado pela loja no momento da criação do pedido.

- idPedidoParceiro: (string)
É o seu codigo de pedido.

Parâmetros de Retorno:

- numeroPedido: (integer)
Número do pedido gerado pelo sistema

- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido

- mensagem: (string)
Mensagem de erro ou sucesso gerada pelo sistema. Em caso de sucesso será gerado o mensagem "sucesso" ou "pedido já cancelado"

Dados de Entrada:

{
"pedido":{
      "codigoPedido": 0,
      "idPedidoParceiro": "string"
}
}

Dados JSON de Retorno:

{
"pedido":{
      "codigoPedido": 0,
      "idPedidoParceiro": "string",
      "mensagem": "string"
}
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Para Financeiro do Parceiro usar:
- POST/pedido: Operação que cria um pedido no Lojista. Todo pedido gerado entrará com status novo.
- DELETE/pedido: Operação para cancelar um pedido pendente/novo.
- PUT/pedido: Operação para Aprovar um pedido pendente/novo.
- GET/pedido: Operação para consultar o detalhe do pedido: status, chave da nota, rastreio, etc..
Para Financeiro do Loja usar:
- POST/pedido: Operação que cria um pedido no Lojista. Todo pedido gerado entrará com status novo.
- GET/pedido: Operação para consultar o detalhe do pedido: status, chave da nota, rastreio, etc..
- GET/pedidoDadosPagamento: Operação enviar os dados de pagamento para transacionar.
Fulfillment: Recurso para o gerenciamento de notas fiscais geradas pelo parceiro
GET
v1/pedido/fulfillment/{numeroPagina}
Retorna lista de pedidos fulfillment

Notas:

Retorna todos os pedidos fulfillment que ainda não foi confirmado a sincronização dos dados fiscais pelo erp.
A lista de pedidos retornados é dividida em lotes de 20 pedidos por pagina, o número da página deve ser passado por parâmetro.
A ordenação dos pedidos é feita utilizando a data como parâmetro ordem decrescente.

OBS: Api utilizada para sincronizar pedidos Fulfillment do Mercado Livre, os pedidos são faturados pelo sistema deles e está api retorna o xml e danf gerado pelo sistema de faturamento do Mercado livre.

"Sempre que os dados do pedido for consumido com sucesso pelo erp, o pedido deve ser removido da fila utilizando a api de confirmação de recebimento".

Parâmetros de Entrada:

Parâmetros de Retorno:

- codigoPrecode
codigo de referencia do pedido na precode

- codigoMarketplace
codigo de referencia do pedido no marketplace

- numeroNf
Numero da nota

- chaveNf
chave completa da nota

- linkXmlNf
Link do xml

- linkPdfNf
link do pdf

- data
data do pedido

Dados de Entrada:

- numeroPagina
Representa o numero da pagina, o parametro deve ser inserido na url

Dados JSON de Retorno:

[
   {
      "codigoPrecode": 0,
      "codigoMarketplace": "",
      "numeroNf": "",
      "chaveNf": "",
      "linkXmlNf": "",
      "linkPdfNf": "",
      "data": "yyyy-mm-dd H:i:s"
}
]

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/pedido/fulfillment/confirmaRecebimento
Confirma o recebimento dos dados fiscais do pedido

Notas:

Recurso utilizado para confirmar o recebimento dos dados fiscais pelo erp.

Esta api retira o pedido da fila da api de GET pedidos/fulfillment, deve ser utilizada para facilitar o gerenciamento de sincronizações de pedidos.

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

{
"codigoPrecode": "codigo do pedido precode"
}

Dados JSON de Retorno:

se ocorrer erro

faixa de status http 400
{
   "codigoErro": "cod erro",
   "mensagem": "descrição erro"
}

processado com sucesso

status Http 200
{
   "mensagem": "mensagem sucesso"
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
SAC: Recurso para gerenciamento de chamados
POST
v1/sac/ticket
Recurso para registrar um chamado SAC

Notas:

Recurso para registrar um chamado SAC

Parâmetros de Entrada:

- idTicktCliente: (string) (obrigatório)
É o seu codigo SAC de atendimento. Utilizar um ID único.

- idPedidoParceiro: (string) (obrigatório)
Caso o atendimento seja referente a um pedido, informar o codigo do pedido parceiro, ou seja, o seu número de pedido.

- nomeCliente: (string) (obrigatório)
Favor informar o nome do cliente/pessoa de contato.

- descricaoTickt: (string) (obrigatório)
É a descrição do atendimento, contendo duvidas/reclamações. Caso não seja enviado o código do pedido informar detalhes de contato do cliente.

Parâmetros de Retorno:

- idTicktCliente: (string)
É o seu codigo SAC de atendimento.

- idTicktLoja: (string)
Número do chamado SAC gerado pela loja.

- mensagem: (string)
Mensagem de retorno

Dados de Entrada:

{
"tickt":
{
    "idTicktCliente": "string",
    "idPedidoParceiro": "string",
    "nomeCliente": "string",
    "descricaoTickt": "string"
}
}

Dados JSON de Retorno:

{
"tickt":
{
    "idTicktCliente": "string",
    "idTicktLoja": "string"
    "mensagem": "string"
}
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/sac/ticket
Recurso para consultar um chamado SAC

Notas:

Recurso para consultar um chamado SAC

Parâmetros de Entrada:

Informar o idTicktCliente ou idTicktLoja na entrada JSON.
- idTicktCliente: (string)
É o seu codigo SAC de atendimento.

- idTicktLoja: (string)
Número do chamado SAC gerado pela loja.

Parâmetros de Retorno:

- idTicktCliente: (string)
É o seu codigo SAC de atendimento.

- idTicktLoja: (string)
Número do chamado SAC gerado pela loja.

- idPedido: (string)
Número do pedido da loja.

- nomeCliente: (string)
Nome do cliente.

- data: (string)
Data que foi aberto o atendimento.

- descricaoTickt: (string)
Descrição da solicitação do atendimento.

- nomeAtendenteResponsavel: (string)
Nome do atendente que irá ou já respondeu o chamado.

- situacao: (string)
Situação do atendimento: Respondido ou Pendente

- dataResposta: (string)
Data que foi finalisado o chamado.

- descricaoResposta: (string)
É os dados da resposta que o atendente respondeu.

Dados de Entrada:

{
"tickt":
{
    "idTicktCliente": "string",
    "idTicktLoja": "string"
}
}

Dados JSON de Retorno:

{
"tickt":
{
    "idTicktCliente": "string",
    "idTicktLoja": "string",
    "idPedido": "string",
    "nomeCliente": "string",
    "data": "string",
    "descricaoTickt": "string",
    "nomeAtendenteResponsavel": "string",
    "situacao": "string",
    "dataResposta": "string",
    "descricaoResposta": "string"
}
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/sac/ocorrencias/{dataInicial}/{dataFinal}
Recurso para listar as Ocorrências Internas

Notas:

Recurso para listar os chamados internos

Parâmetros de Entrada:

- dataInicial (data) (requerido)
- dataFinal (data) (requerido)

O periodo não pode ser superior a 31 dias

Parâmetros de Retorno:

- ID_Ocorrencia (inteiro)
Código da ocorrência

- codigoPedido (inteiro)
Código do pedido site

- dataAbertura (data)
Data da criação da ocorrência

- dataResolve (data)
Data do encerramento

- situacao (string)
Situação do chamado "Resolvido" ou "A Resolver"

- prioridade (inteiro)
Prioridade na resolcução

- responsavelResolve (string)
Nome do responsavel em resolver a ocorrência

- criadoPor (string)
Nome do usuario que criou a ocorrência

- mensagem (string)
Mensagem da ocorrência

titulo (string)
Titulo da ocorrência.

Dados de Entrada:

sac/ocorrencias/{dataInicial}/{dataFinal}

Dados JSON de Retorno:

{
   "ocorrencias": [{
         "ID_Ocorrencia": 0
         "codigoPedido": 0,
         "dataAbertura": "",
         "dataResolve": "",
         "situacao": "",
         "prioridade": 0,
         "responsavelResolve": "",
         "criadoPor": "",
         "mensagem": "",
         "titulo": ""
      }]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
ControleMostruario: Recurso para gerenciamento de chamados
POST
v1/controleMostruario/pedidoMostruario
Cria um pedido de mostruario

Notas:

Cria um pedido de mostruario no Lojista.

Parâmetros de Entrada:

- idPedidoParceiro: (string) (obrigatório)
É o seu codigo de pedido.

- valorFrete: (numeric) (obrigatório)
Valor total do frete.

- codFilialVenda: (integer) (obrigatório)
Codigo da filial que fez a venda

- prazoEntrega:(integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- valorTotalCompra: (numeric)
Valor total da compra. Soma entre o total de pedidos + total de itens. Caso seja seja enviado o sistema não irá realizar a validação.

- formaPagamento: (string) (obrigatório)
Forma de pagamento. Exemplo: visa, mastercard, dieners, boleto. Cada loja irá fornecer a lista das formas de pagamentos disponiveis.

- cpfCnpj: (string) (obrigatório)
CPF ou CNPJ do cliente

- nomeRazao: (string) (obrigatório)
Nome do cliente ou Razão social da empresa

- fantasia: (string) (obrigatório)
Apelido do cliente ou nome Fantasia da Loja

- sexo: (string) (opcional)
Usar M ou F

- dataNascimento: (string) (opcional)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy

- email: (string) (obrigatório)
E-mail do cliente.

- cep: (string) (obrigatório)
CEP do endereço de entrega

- numero: (string) (obrigatório)
Número da residência, caso não tenha enviar s/n

- bairro: (string) (obrigatório)
Bairro do endereço de entrega

- complemento: (string)
Complemento ou ponto de referência do endereço de entrega

- cidade: (string) (obrigatório)
Cidade do endereço de entrega

- uf: (string) (obrigatório)
Estado do endereço de entrega

- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal

- residencial: (string) (obrigatório)
Telefone residencial do cliente

- comercial: (string)
Telefone comercial caso tenha

- celular: (string) (obrigatório)
Telefone celular do cliente

Pagamento:
- valor: (numeric) (obrigatório)
Valor total do meio de pagamento.

- quantidadeParcelas: (integer) (obrigatório)
Quantidade de parcelas do meio de pagamento.

- meioPagamento: (string) (opcional)
Nome do meio do pagamento, exemplo: visa, master, boleto.

- autorizacao: (string) (opcional)
Número da autorização. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.

- nsu: (string) (opcional)
Número do NSU. Obrigatório somente quando o gateway de pagamento for da loja e a transação for realizada pelo parceiro e somente quando for venda cartão.

Itens:
- sku: (integer) (obrigatório)
Código SKU do produto

- valorUnitario: (numeric) (obrigatório)
Valor unitário do produto

- quantidade: (integer) (obrigatório)
Quantidade de itens comprado do sku

Parâmetros de Retorno:

- numeroPedido: (integer)
Número do pedido gerado pela loja

- idPedidoParceiro: (string)
É o seu código de pedido, ou seja, o código enviado no momento de gerar o pedido

- mensagem: (string)
Mensagem de erro ou sucesso gerada pelo sistema. Em caso de sucesso será gerado o mensagem "sucesso" ou "pedido já gerado"

Dados de Entrada:

{
   "pedido":
   {
      "idPedidoParceiro": "string",
"codFilialVenda": 0,
       "valorFrete": 0,
       "prazoEntrega": 0,
       "valorTotalCompra": 0,
       "formaPagamento": "string",
       "dadosCliente":
        {
            "cpfCnpj": "string",
            "nomeRazao": "string",
            "fantasia": "string",
            "sexo": "string",
            "dataNascimento": "string",
            "email": "string",
             "dadosEntrega":
             {
                  "cep": "string",
                  "endereco": "string",
                  "numero": "string",
                  "bairro": "string",
                  "complemento": "string",
                  "cidade": "string",
                  "uf": "string",
                  "responsavelRecebimento": "string"
            },
          "telefones":
          {
            "residencial": "string",
            "comercial": "string",
            "celular": "string"
         }
},
"pagamento": [
{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "string",
         "autorizacao": "string",
         "nsu": "string"
}],
"itens": [
{
         "sku": 0,
         "valorUnitario": 0,
         "quantidade": 0
}
]
}
}

Dados JSON de Retorno:

{
"pedido":{
"numeroPedido": 0,
"idPedidoParceiro": "string",
"mensagem": "string"
}
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/controleMostruario/listarMostruarios
Lista todos os Mostruarios

Notas:

Retorna informações dos Mostruarios disponiveis para venda.

Parâmetros de Entrada:

Parâmetros de Retorno:

- mostruarios: (array)
- sku: (integer)
- codigoAgrupador: (integer)
- gradex: (integer)
- nomeGradex: (string)
- gradey: (integer)
- nomeGradey: (string)
- titulo: (string)
- saldoTotal: (integer)
- saldoDisponivel: (integer)
- preco: (integer)

Dados de Entrada:

Dados JSON de Retorno:

{
   "mostruarios": [{
"sku": 0,
"codigoAgrupador": 0,
"gradex": 0,
"nomeGradex": "string",
"gradey": 0,
"nomeGradey": "string",
"titulo": "string",
"saldoTotal": 0,
"saldoDisponivel": 0,
"preco": 0
}]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v1/controleMostruario/informarSaldo
Informar saldo de mostruario

Notas:

Recurso para informar o total de mostruario estocado em cada filial

Parâmetros de Entrada:

- filiais: (Array) (obrigatorio)
OBS: limite de 3000 index por requisição

- codFilial: (integer) (obrigatorio)

- sku: (integer) (obrigatorio)

- saldo: (integer) (obrigatorio)

Parâmetros de Retorno:

- requisicoesProcessadas: (integer)
Total de alterações/inserções processadas

- sucesso: (integer)
total de alterações/inserções bem sucedidas

- erro: (integer)
total de erros, caso ocorra

- LogErro: (Array)
Mensagens dos erros

Dados de Entrada:

{
"filiais": [{
"codFilial": 0,
"sku": 0,
"saldo": 0
}]
}

Dados JSON de Retorno:

{
"requisicoesProcessadas": 0,
"sucesso": 0,
"erro": 0,
"logErro" : ["string"]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Financeiro: Recurso para obter dados dos titulos financeiros.
GET
v1/financeiro/ciclos
Consulta Ciclos Importados

Notas:

Recurso para listar os ciclos que foram importados dos marketplaces

Parâmetros de Entrada:

Parâmetros de Retorno:

- data: (data)
Data da imprtação do arquivo

- marketplace: (string)
Nome Marketplace

Utilizar os 2 campos para pesquisa detalhada em
GET financeiro/titulos/{data}/{marketplace}

Dados de Entrada:

Dados JSON de Retorno:

{
   "ciclos": [{
      "data": "",
      "marketplace": ""
   }]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/financeiro/titulos/{data}/{marketplace}
Consulta titulos

Notas:

Recuros para receber os titulos pagos, cancelados e o resumo do ciclo.

Parâmetros de Entrada:

- data: (data) (obrigatorio)
Data da importação do arquivo do marketplace

- marketplace: (string) (obrigatorio)
Nome do marketplace

- Lista de Marketplaces:
MercadoPago
Cnova
Walmart
B2W
Zoom
BuscapeCPA
Carrefour
MagazineLuiza
RicardoEletro
CissaMagazine
Amazon
MadeiraMadeira
WebContinental
Colombo
LeroyMerlin

Parâmetros de Retorno:

Titulos:

- tipo: (string)
Tipo de registro Venda/Cancelamento

- codigoTitulo: (inteiro)
Código interno do registro do titulo

- valorParcela: (numerico)
Valor total da parcela

- valorPago: (numerico)
Valor pago pelo marketplace

- valorCancelado: (numerico)
Valor cancelado

- parcela: (numerico)
Parcela paga/cancelada

- valorComissao: (numerico)
Valor retido de comissão pelo marketplace

- codigoPedido: (inteiro)
Número do pedido site.

- codigoPedidoERP: (inteiro)
Número do pedido ERP

- tituloERP: (inteiro)
Número do titulo no ERP

- notaFiscal: (inteiro)
Número da nota fiscal do ERP

- codigoMarketplace: (string)
Número do pedido no marketplace

- cpfCliente: (string)
Número do documento do cliente

- nomeCliente: (string)
Nome do Cliente

- filialFatura: (inteiro)
Número da filial ERP onde ocorreu o faturamento

- dataCancelamento: (data)
Data do Cancelamento

- dataPagamento: (data)
Data do Pagamento

- totalPedido: (Numerico)
Valor total da compra

- totalParcelas: (Numerico)
Valor total da parcela

Resumo:

- totalParcelas: (String)
Nome do Marketplace

- vendaPedido: (Numerico)
Valor total do ciclo importado

- vendaComissao: (Numerico)
Valor total da comissão

- cancelamentoPedido: (Numerico)
Valor total do cancelamento

- cancelamentoComissao: (Numerico)
Valor total do cancelamento da comissão

- repasseLiqudido: (Numerico)
Valor total do ciclo depositado

- outros: (array)

- descricao: (String)
Descrição da receita/despesa

- valor: (Numerico)
Valor da receita/despesa

Dados de Entrada:

Dados JSON de Retorno:

{
   "titulos": [{
      "tipo": "",
      "codigoTitulo": 0,
      "valorParcela": 0,
      "valorPago": 0,
      "valorCancelado": 0,
      "parcela": 0,
      "valorComissao": 0,
      "codigoPedido": 0,
      "codigoPedidoERP": 0,
      "tituloERP": 0,
      "notaFiscal": 0,
      "codigoMarketplace": "",
      "cpfCliente": "",
      "nomeCliente": "",
      "filialFatura": 0,
      "dataCancelamento": 0,
      "dataPagamento": "0",
      "totalPedido": 0,
      "totalParcelas": 0
   }],
   "resumo": {
      "marketplace": "",
      "vendaPedido": 0,
      "vendaComissao": 0,
      "cancelamentoPedido": 0,
      "cancelamentoComissao": 0,
      "repasseLiqudido": 0,
      "outros": [{
            "descricao": "",
            "valor": 0
         }
      ]
   }
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Pedido ERP: Recurso para gerenciamento de pedidos em ERPs
GET
v1/erp/novo/{númerodapagina}
Recupera lista de pedidos pendentes

Notas:

Recupera lista de pedidos pendentes. (pedidos para serem reservados, e não liberados para faturamento).

Parâmetros de Entrada:

Retornará os 100 ultimos novos registros.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/reserva
Confirma que os produtos do pedido foram reservados.

Notas:

Recurso para informar a reserva do pedido pentende.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido site.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0
},
{
    "codigoPedido": 0
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/cancelado
Recupera a lista de pedidos cancelados

Notas:

Recupera lista de pedidos cancelados.

Parâmetros de Entrada:

Retornará os 100 ultimos novos registros.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/cancelado
Informa leitura do pedido cancelado

Notas:

Recurso para informar a leitura do pedido como cancelado.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido site.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0
},
{
    "codigoPedido": 0
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/aprovado/{númerodapagina}
Recupera lista de pedidos aprovados

Notas:

Recupera lista de pedidos aprovados. (pedidos prontos para serem faturados).

Parâmetros de Entrada:

Recupera lista de pedidos aprovados. LImite de 100 registros por pagina.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- tipoPedido
Informa se o pedido é fulfillment ou não, valores possiveis ["fulfillment", "default"]
OBS: Se o pedido for fulfillment e do mercado livre, o mesmo não deve ser faturado pelo erp, pois o faturamento ocorre pelo sistema do mercado livre,
a nota e xml gerado pelo mercado livre é retornada pela api pedido/fulfillment.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
"tipoPedido": "",
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/aceite
Informa nº do PedidoERP (aceite de pedido aprovado)

Notas:

Recurso para informar o número do pedido ERP e realizar o aceite do pedido.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido site.

- numeroPedidoERP: (integer) (obrigatório)
Número do pedido ERP

- numeroFilialFatura (string) (obrigatório para empresas configuradas com mais de uma Filial)
Número da Filial de Faturamento.

- numeroFilialSaldo (string) (obrigatório para empresas configuradas com mais de centro de distribuição)
Número do centro de distribuição.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0,
    "numeroPedidoERP": 0,
    "numeroFilialFatura": 0,
    "numeroFilialSaldo": 0
},
{
    "codigoPedido": 0,
    "numeroPedidoERP": 0,
    "numeroFilialFatura": 0,
    "numeroFilialSaldo": 0
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/pedidosemestoque
Informa pedido sem estoque

Notas:

Recurso para informar que o produto não tem estoque.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido site.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0
},
{
    "codigoPedido": 0
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/pedidossemestoque
Recupera uma lista de pedidos sem estoque

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

Dados JSON de Retorno:

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/nf
Recupera uma lista de pedidos aguardando Nota Fiscal

Notas:

Recupera lista de pedidos aguardando nota fiscal.

Parâmetros de Entrada:

Retornará os 100 ultimos novos registros.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/faturamento
Informa dados do Faturamento: chave, url e xml

Notas:

Recurso para informar os dados nota fiscal.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido precode.

- chaveNF (string) (obrigatório)
Chave da Nota Fiscal

- url (string) (não obrigatório)
Url PDF da nota fiscal, para que o cliente possa imprimir sua nota.

- xml (string) (obrigatório)
xml da nota fiscal.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0,
    "chaveNF": "",
    "url": "",
    "xml": "{enviar convertido em base64}"
},
{
    "codigoPedido": 0,
    "chaveNF": "",
    "url": "",
    "xml": "{enviar convertido em base64}"
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/envio
Recupera uma lista de pedidos aguardando coleta

Notas:

Recupera lista de pedidos aguardando coleta. (envio ao cliente)

Parâmetros de Entrada:

Retornará os 100 ultimos novos registros.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/envio
Informa envio do pedido

Notas:

Recurso para informar o envio do pedido ao cliente.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido site.

- protocoloCorreio (string) (opcional)
Se o produto for enviado por correios, informar protocolo.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0,
    "protocoloCorreio": ""
},
{
    "codigoPedido": 0,
    "protocoloCorreio": ""
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/entregue
Recupera uma lista de pedidos pendente entrega

Notas:

Recupera lista de pedidos pendente entrega.

Parâmetros de Entrada:

Retornará os 100 ultimos novos registros.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
PUT
v1/erp/entregue
Informa pedido entregue ao cliente

Notas:

Recurso para informar pedido entregue ao cliente.

Parâmetros de Entrada:

- codigoPedido: (integer) (obrigatório)
Número do pedido site.

Parâmetros de Retorno:

- codigoPedido: (integer)
Código do pedido site.

- idRetorno: (integer)
0 (zero) para sucesso.

- mensagem: (string)
Mensagem de retorno.

Dados de Entrada:

{
"pedido": [
{
    "codigoPedido": 0
},
{
    "codigoPedido": 0
}
]
}

Dados JSON de Retorno:

{
"pedido": [
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
},
{
    "codigoPedido": 0,
    "idRetorno": 0
    "mensagem": ""
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/status/{codigoPedido}
Retorna detalhes de um pedido

Notas:

Retorna informações de um pedido

Parâmetros de Entrada:

- codigoPedido: (integer)
Número do pedido site.

Parâmetros de Retorno:

- codigoPedido: (integer)
Número do pedido Site/Precode.

- pedidoParceiro: (string)
Número do pedido marketplace.

- pedidoIndenizado (bolean)
Informa se o pedido será indenizado pela transportadora.

- codigoMapa(integer)
Número do mapa de carga.

- statusAtual (string)
Descrição abreviada do status atual: novo, analisando, aprovado, faturando, coletando, em viagem, entregue e cancelado.

- valorFrete: (numeric)
Valor total do frete.

- previsaoEntrega: (integer)
Prazo de entrega em dias corridos. Caso não seja preenchido o sistema irá calcular o prazo em nosso sistema.

- previsaoEntrega: (data)
Prazo de entrega em data dd-mm-yyyy

- valorTotalCompra: (numeric)
Valor total da compra. (valorUnitarioLiquido * quantidade) + valorFrete.
- valorTotalDesconto: (numeric)
Valor total de desconto na venda. Utilizar esse campo se o seu ERP possuir o campo de desconto e utilizar no item do pedido o campo valorUnitario. Caso não possua o campo desconto, desconsidere o valorTotalDesconto e utilize no item do pedido o valorUnitarioLiquido que é o campo já com o valor do desconto.
- idAfiliado: (integer)
Código do canal/afiliados/vendedor/marketplace que realizou a venda.
- nomeAfiliado (string)
Nome do canal/afiliados/vendedor/marketplace
- cpfCnpj: (string)
CPF ou CNPJ do cliente
- tipo: (string)
Tipo do cliente F (pessoa Física) ou J (pessoa Juridica)
- nomeRazao: (string)
Nome do cliente ou Razão social da empresa
- fantasia: (string)
Apelido do cliente ou nome Fantasia da Loja
- sexo: (string)
Usar M ou F
- dataNascimento: (string)
Caso o cliente seja Pessoa Física enviar no formato dd-mm-yyyy
- email: (string)
E-mail do cliente.
- cep: (string)
CEP do endereço de entrega
- numero: (string)
Número da residência, caso não tenha enviar s/n
- bairro: (string)
Bairro do endereço de entrega
- complemento: (string)
Complemento ou ponto de referência do endereço de entrega
- cidade: (string)
Cidade do endereço de entrega
- uf: (string)
Estado do endereço de entrega
- codigoIBGE: (string)
Estado IBGE da cidade
- responsavelRecebimento: (string)
Nome da pessoa responsável pelo recebimento do pedido, será impresso na observação da nota fiscal
- residencial: (string)
Telefone residencial do cliente
- comercial: (string)
Telefone comercial caso tenha
- celular: (string)
Telefone celular do cliente
Pagamento:
- valor: (numerica)
Valor total do meio de pagamento
- quantidadeParcelas: (integer)
Quantidade de parcelas do meio de pagamento
- meioPagamento: (string)
Descrição do meio de pagamento
- autorizacao: (string)
Número da autorização do cartão de crédito.
- nsu: (string)
Número NSU do cartão de crédito.
Itens:
- sku: (integer)
Código SKU do produto

- referenciaLoja: (string)
Campo com o codigo/referencia empresa (código sku do ERP)
- descricaoProduto: (string)
Campo de referência da Descrição do produto
- descricaoOpcao: (string)
Campo de referencia da opção escolhida, como: cor, voltagem, tamanho, sabor, etc.
- valorUnitario: (numeric)
Valor unitário bruto do produto
- valorUnitarioLiquido: (numeric)
Valor unitário liquido do produto, ou seja, valor já com a dedução dos descontos.
- quantidade: (integer)
Quantidade de itens comprado do sku
Dados Rastreio:
- nomeroNotaFiscal (integer)
Número da nota fiscal se o pedido esteja faturado.
- chaveNotaFiscal (string)
chave da nota fiscal se o pedido esteja faturado.
- dataFaturamento (string)
data da nota fiscal.
- idCentroDistribuicao (string)
Código do Centro de Distribuição
- cidadeDistribuicao (string)
Cidade onde o produto saiu
- ufCentroDistribuicao (string)
Estado onde o produto saiu
- idTransportadora (integer)
Código da transportadora que está transportando o produto

- transportadora (string)
Nome da transportadora que está transportando o produto
- urlRastreio (string)
URL de rastreio junto a transportadora
- protocoloCorreios (string)
Código do protocolo de rastreio junto aos correios, se o produto despachado pelos correios.
Dados Acompanhamento:
- data (string) data da ação do status
- hora (string) hora da ação do status
- descricao (string) descrição detalhada no status

Dados de Entrada:

status/{codigo/pedido}

Dados JSON de Retorno:

{
   "pedido": [{
      "codigoPedido": 0,
      "pedidoParceiro": "",
      "pedidoIndenizado": false,
      "codigoMapa": 0,
      "statusAtual": "",
      "valorFrete": 0,
      "prazoEntrega": 0,
      "previsaoEntrega": "2019-01-01",
      "valorTotalCompra": 0,
      "valorTotalDesconto": 0,
      "idAfiliado": 0,
      "nomeAfiliado": "",
      "codigoStatusAtual": "",
      "dadosCliente": {
         "cpfCnpj": "",
         "tipo": "",
         "nomeRazao": "",
         "fantasia": "",
         "sexo": "",
         "dataNascimento": "1980-01-01",
         "email": "",
         "dadosEntrega": {
            "cep": "",
            "endereco": "",
            "numero": "",
            "bairro": "",
            "complemento": "",
            "cidade": "",
            "uf": "",
            "codigoIBGE": "",
            "responsavelRecebimento": ""
         },
         "telefones": {
            "residencial": "",
            "comercial": "",
            "celular": ""
         }
      },
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "descricaoProduto": "",
         "descricaoOpcao": "",
         "valorUnitario": 0,
         "valorUnitarioLiquido": 0,
         "quantidade": 0,
         "ncm": "",
         "volumesUnitario": "",
         "pesoUnitario": 0
      }],
      "pagamento": [{
         "valor": 0,
         "quantidadeParcelas": 0,
         "meioPagamento": "",
         "autorizacao": "",
         "nsu": "",
         "nsuHost": ""
      }],
      "dadosRastreio": {
         "pedidoERP": 0,
         "nomeroNotaFiscal": 0,
         "chaveNotaFiscal": "",
         "dataFaturamento": "",
         "idCentroDistribuicao": 0,
         "cidadeDistribuicao": "",
         "ufCentroDistribuicao": "",
         "idTransportadora": 0,
         "transportadora": "",
         "CNPJtransportadora": "",
         "urlRastreio": "",
         "protocoloCorreios": ""
      },
      "dadosAcompanhamento": [{
         "codigoStatusAtual": 0,
         "data": "2019-01-01",
         "hora": "00:00:00",
         "descricao": "",
         "descricaoDetalhe": ""
      }]
   }],
   "paginas": 1,
   "total": 1
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/erp/transportadora
Recupera lista de transportadoras ativas

Notas:

Recupera lista de transportadoras ativas.

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

Dados JSON de Retorno:

{
"transportadora": [
{
"codigo": 0,
"nome": ""
}]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/labels/generateLabels
Retorna etiquetas de expedição por pedido

Notas:

Retorna as etiquetas de expedição de acordo com o formato desejado, no momento esta funcionando com b2w envios, mercado livre envios, integração direta com os correios e transportadoras.

Parâmetros de Entrada:

- orders
Codigo do pedido, no momento só é possivel gerar uma etiqueta por requisição e a loja precisa estar configurada para gerar mapas de carga automaticamente.

- responseType
Tipo de etiqueta que deseja gerar, valores validos: pdf, json e zpl
obs: formato zpl é criado para o tamanho padrão de etiqueta termica 150X100

Parâmetros de Retorno:

para a opção zpl é retornado um arquivo .zip contendo um txt com os códigos zpl e um arquivo pdf para plp caso o a transportadora do pedido seja o correios, na opção de pdf retorna um pdf no formato a4 e no formato json retorna o json contendo as informações das etiquetas

Dados de Entrada:

Dados JSON de Retorno:

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Compras: Recurso para gerenciamento de compras
GET
v1/compras/pedidos/semestoque
Lista produtos sem estoque por pedido

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

Dados de Entrada:

Dados JSON de Retorno:

{
   "lista": [{
      "codigoPedido": 0,
      "itens": [{
         "sku": 0,
         "referenciaLoja": "",
         "idCodigoPai": 0,
         "idgradex": 0,
         "idgradey": 0,
         "quantidade": 0,
         "valorUnitario": 0
      }]
   }]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
Logistica: Recurso para gerenciar mapa e romaneio de carga
POST
v1/logistica/romaneio/conferir
Cria romaneio de carga

Notas:

.....

Parâmetros de Entrada:

- codigoDeBarras: (String)
Código de Barras da nota fiscal.

- codigoTransportadora: 0
Código da Tranportadora

- grupoConferencia
Código do Grupo de Conferência (Número aleatório)

Parâmetros de Retorno:

- status: (string)
status de retorno (sucesso ou erro)

- chave: (string)
Código de barras

- codigoPedido: 0
Retorna o código do Pedido

- horaPedido: (hora)
Hora que foi realizada a conferência atual

- dataPedido: (data)
Data que foi realizada a conferência atual

- transportadora: 0
Código da transportadora selecionada

- grupoConferencia: 0
Grupo de conferência para essa conferência

Dados de Entrada:

{
"codigoDeBarras": "String",
"codigoTransportadora": 0,
"grupoConferencia": 0
}

Dados JSON de Retorno:

{
"status": "string",
"pedido": {
"chave": "string",
"codigoPedido": 0,
"horaPedido": "string",
"dataPedido": "string",
"transportadora": 0,
"grupoConferencia": 0
}
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/logistica/romaneio/{grupoConferencia}
Lista conferência pendentes

Notas:

Parâmetros de Entrada:


Parâmetros de Retorno:

- status:(string)
status de retorno (sucesso ou erro)

- grupoConferencia:0
grupo de conferência é o código responsavel por agrupar a conferência atual

- codPedido:0
código do pedido

- dataConferencia: (data)
data que foi realizada a conferência

- horaConferencia: (hora)
hora que foi realizada a conferência

Dados de Entrada:

Dados JSON de Retorno:

{
"status":"string",
"grupoConferencia":0,
"pedidos":[
   {
   "codPedido": 0,
   "dataConferencia": "string",
   "horaConferencia": "string"
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
POST
v1/logistica/romaneio/concluir
Conclui a conferência de carga

Notas:

Parâmetros de Entrada:

- grupoConferencia: 0
Código de agrupamento da conferência

Parâmetros de Retorno:

- status: (string)
status de retorno (sucesso ou erro)

- mensagem: (string)
mensagem do status

Dados de Entrada:

{
"grupoConferencia" : 0
}

Dados JSON de Retorno:

{
"status":"string",
"mensagem":"string"
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
DELETE
v1/logistica/romaneio/excluir/{codigoPedido}
Excluir pedido da lista de conferência

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

- status: (string)
status de retorno (sucesso ou erro)

- mensagem: (string)
mensagem de retorno

Dados de Entrada:


Dados JSON de Retorno:

{
"status":"string",
"mensagem":"string"            
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/logistica/mapadecarga/{codigoMapa}
Lista os produtos do mapa de carga

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

- status: (string)
status do retorno (sucesso ou erro)

- codigoMapa: (int)
código do mapa de carga

- codigoProduto: (string)
código do mapa, separando por pontos (código do produto, codigo cor, codigo voltagem) nessa sequência.

- sku: (int)
código do sku

- ean: (string)
código ean

- descricao: (string)
descrição do produto (nome)

- quantidade: (int)
quantidade do produto

- referencia: (string)
código de referência da empresa

Dados de Entrada:

Dados JSON de Retorno:

{
"status":"string",
"codigoMapa":0,
"produtos": [
{
"codigoProduto":"string",
"sku":0,
"ean":"string",
"descricao":"string",
"quantidade":0,
"referencia":"string"
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada
GET
v1/logistica/mapadecarga/{codigoMapa}/{codigoEan}
Lista mais detalhes da compra

Notas:

Parâmetros de Entrada:

Parâmetros de Retorno:

- status: (string)
status do retorno (sucesso ou erro)

- codigoPedido: (string)
código do Pedido

- quantidade: (string)
Quantidade de produtos na compra

- nomeCliente: (string)
Nome do cliente

- cliCpfCnpj: (string)
CPF ou CNPJ do Cliente

Dados de Entrada:


Dados JSON de Retorno:

{
"status":"string",
"dados":[
{
"codigoPedido": "string",
"quantidade": 0,
"nomeCliente": "string",
"cliCpfCnpj": "string"
                     
}
]
}

Codigos de Respostas:

200
Sucesso
201
Sucesso
400
Requisição incorreta
401
Chave Invalida
402
Chave Inativa
403
Sem não tem Permissão de acesso a esta area
405
Sistema temporariamente indisponivel. Tente mais novamente mais tarde
404
Pagina/Recurso não encontrada
406
Metodo não permitido para esta requisição
407
Limite de requisições ultrapassada
408
Falta de parametros de entrada