INTRODUÇÃO
Objetivo
Permitir que os lojistas se integrem como Marktplace B2C.
Plataforma
Os serviços são expostos via API acessíveis por chamadas web utilizando métodos GET e POST em HTTP.
Interface da API
Os seguintes métodos são expostos nos webservices da Integração:
- PostProduto
- PostEstoque
- GetPedido
- PostPedidoStatus
- GetCategoria
A URL base da API RESTFul é: https://developers.addsuite.com.br/marketplaceb2c/
ACESSO A API DE INTEGRACAO
Será gerado um TOKEN e um LOGIN do tipo GUID que será fornecido ao parceiro. Este código é parâmetro obrigatório de todas as chamadas da API.
MÉTODOS DA API
Os métodos com a nomenclatura iniciada com GET são encarregados de obter informações da base do MktPlace. Todos eles são acessados diretamente por uma URL contendo o nome do método na qual devem ser fornecidos alguns parâmetros que estão detalhados a seguir; o retorno é fornecido via padrão JSON. O método com nomenclatura iniciada com POST é encarregado de transferir informações do parceiro para o MKTPlace.
PostProduto
Este método tem o propósito o envio de produto.
URL: https://developers.addsuite.com.br/marketplaceb2c/wsintegracao/PostProduto
Método: PostProduto
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
Departamento |
|
|
|
Nome |
string |
Nome do departamento. |
|
codigo |
inteiro |
Identificação do departamento. |
|
Secao |
|
|
|
Nome |
string |
Nome da categoria pertencente a um departamento. |
|
codigo |
inteiro |
Identificação da categoria. |
|
codigodepartamento |
inteiro |
|
|
Atributo |
|
|
|
Nome |
string |
Nome do atributo do produto. (Ex: Cor, Tamanho, Voltagem). |
|
atributoid |
inteiro |
Identificação do atributo. |
|
AtributoItem |
|
|
|
Nome |
string |
Nome do atributo do produto. (Ex: vermelho, Tamanho, amarelo). |
|
atributoid |
inteiro |
Identificação do atributo. |
|
atributoitemid |
inteiro |
Identificação do atributo item. |
|
Produto |
|
|
|
nomeproduto |
|
Nome do Produto |
|
codigoproduto |
|
Identificação do produto no parceiro. |
|
SKU |
|
Identificação do produto no Fabricante. |
|
FABRICANTE |
|
Nome do fabricante. |
|
descricaoproduto |
|
Descrição do produto. |
|
peso |
|
Peso do produto |
|
largura |
|
Largura do produto |
|
altura |
|
Altura do Produto |
|
profundidade |
|
Profundidade do Produto |
|
preco |
|
Preço do produto |
|
precopromocao |
|
Preço do Promoção do produto |
|
imagem |
|
Link da imagem do produto |
|
prazoentrega |
|
Prazo de entrega adicional do produto |
|
prazogarantia |
|
Prazo de garantia do produto |
|
ativo |
|
S ou N para o produto |
|
Personalizacao |
|
Se produto permite personalização (nome do bebe) |
|
local |
|
|
|
codepto |
|
Neste campo deverá vir o código do departamento, que irá remeter para a tabela de departamento que também deve vir mapeada no arquivo XML, conforme descrito na tabela de departamentos.
|
|
codsecao |
|
Neste campo deverá vir o código da categoria, que irá remeter para a tabela de departamento que também deve vir mapeada no arquivo XML, conforme descrito na tabela de departamentos / categorias. |
|
modelo |
|
|
|
Item |
|
Neste campo deverá vir um identificador de modelos do produto. |
|
codigoprodutomodelo |
|
|
|
codigofabricante |
|
|
|
atributoitem |
|
Neste campo deverá vir o código dos atributos que compõe cada modelo do produto. Exemplo: O produto é uma geladeira branca, com tamanho grande de 350 litros e com voltagem 110. Então para este produto será enviado 3 atributos. um para identificar a cor, outro para identificar o tamanho e outro para identificar a voltagem. Para o sistema da loja localizar estes atributos, será usado a tabela de atributos e itens descritos acima. |
{
"postproduto": {
"departamento": [
{
"nome": "CINE E FOTO",
"codigo": "01"
},
{
"nome": "ELETRONICOS",
"codigo": "02"
}
],
"secao": [
{
"nome": "Câmeras Digitais - Até 1 Megapixel",
"codigo": "010404",
"codigodepartamento": "01"
},
{
"nome": "DVD",
"codigo": "020404",
"codigodepartamento": "02"
}
],
"atributo": [
{
"nome": "cor",
"atributoid": "1"
},
{
"nome": "tamanho",
"atributoid": "3"
}
],
"atributoitem": [
{
"nome": "P",
"atributoitemid": "5",
"atributoid": "3"
},
{
"nome": "VERMELHO",
"atributoitemid": "6",
"atributoid": "1"
}
],
"produto": [
{
"nomeproduto": "o nome do produto",
"codigoproduto": "0001",
"SKU": "codigo do fabricante",
"FABRICANTE": "nome do fabricante",
"descricaoproduto": "descrilonga",
"peso": "1,00",
"largura": "10,5",
"altura": "5,01",
"profundidade": "10,00",
"preco": "1000,50",
"precopromocao": "850,00",
"imagem": "http://imagemdoproduto.com.br",
"prazoentrega": "2",
"prazogarantia": "10",
"ativo": "S",
"personalizacao": "S",
"local": {
"codepto": "02",
"codsecao": "01"
},
"modelo": {
"item": "1",
"CodigoProdutoModelo": "codigo do fabricante",
"estoque": "10",
"atributoitem": [
{ "item": "5" },
{ "item": "6" }
]
}
}
]
}
}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicável.
{
"codigo":0,
"ticket":”2C958E36-F2FB-4B0E-9245-2F84A54EE910”,
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
PostEstoque
Este método envia e atualiza estoque de diversos skus.
URL: https://developers.addsuite.com.br/marketplaceb2c/wsintegracao/ProdutoEstoque
Método: PostEstoque
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
{
"postestoque": [
{
"SKU": "XXXX",
"estoque": "10",
“preco_normal”:”1000,50”,
“preco_promocao”:”900,00”
},
{
"SKU": "”XXX1”",
"estoque": "”1”" ,
“preco_normal”:”1000,50”,
“preco_promocao”:”900,00”
},
{
"SKU": "XXX2",
"estoque": "45",
“preco_normal”:”1000,50”,
“preco_promocao”:”900,00”
},
{ "SKU": "”XXX3”",
"estoque": "100",
“preco_normal”:”1000,50”,
“preco_promocao”:”900,00”
},
{
"SKU": "XXX4",
"estoque": "4",
“preco_normal”:”1000,50”,
“preco_promocao”:”900,00”
}
]
}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicável.
{
"codigo":0,
"ticket":”2C958E36-F2FB-4B0E-9245-2F84A54EE910”,
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
GetPedido
Este método retorna todos os pedidos efetuados para a loja.
URL:https://developers.addsuite.com.br/marketplaceb2c/wsintegracao/RecuperarPedidos
Método: GetPedido
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
Data inicio |
datetime |
Data para fazer a consulta de um período. |
|
Data fim |
datetime |
Data para fazer a consulta de um período. |
|
|
|
|
Dados da consulta: (dados do pedido)
"REcuperarPedidos":
{
"Pedido":{
"datainicio":"2019-07-01","datafim":"2019-08-01",
"dataFim":"2019-07-01","datafim":"2019-08-01"
}
}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicável.
{
"codigo":0,
"ticket":”2C958E36-F2FB-4B0E-9245-2F84A54EE910”,
"mensagem":"Operação efetuada com sucesso",
{
"RecuperarPEdidos": {
"pedido": {
"oder_id": "9911",
"transportadora": "S",
"nometransportadora": "SEDEX",
"formaPagamento": "VISA",
"Parcelas": "1",
"valorfrete": "4,50",
"subtotalcompra": "49,78",
"valorcompra": "56,20",
"porcentagemdesconto": "5",
"datavenda": "01/07/2019"
}
},
"cliente": {
"TipoPessoa": "F",
"CPFCNPJ": "00000000000",
"ClienteNome": "Chleba",
"InscRg": "00000000",
"Email": "[email protected]",
"DTNasc": "1980-10-20",
"Sexo": "M"
},
"endereco": {
"tipoEndereco": "C",
"Nome": "Casa",
"CEP": "80030001",
"Endereco": "Av. João Gualberto",
"Numero": "1259",
"Complemento": "19 andar",
"Bairro": "Juveve",
"Cidade": "Curitiba",
"UF": "PR",
"DDDRes": "41",
"FoneRes": "33236985",
"DDDCom": "41",
"FoneCom": "33139380"
},
"enderecoentrega": {
"tipoEndereco": "C",
"Nome": "Casa",
"CEP": "80030001",
"Endereco": "Av. João Gualberto",
"Numero": "1259",
"Complemento": "19 andar",
"Bairro": "Juveve",
"Cidade": "Curitiba",
"UF": "PR",
"DDDRes": "41",
"FoneRes": "33236985",
"DDDCom": "41",
"FoneCom": "33139380"
},
"itempedidos": [
{
"CodigoProduto": "02647",
"QTDE": "1",
"CodigoProdutoModelo": "YYYYY",
"ValorUnitario": "28,70",
“nomeBebe”; “Jose da Silva"
},
{
"CodigoProduto": "02555",
"QTDE": "10",
"CodigoProdutoModelo": "XXXX",
"ValorUnitario": "1228,70",
“nomeBebe”; “"
}
]
}
PostPedidoStatus
Este método envia e atualiza status dos pedidos.
URL: http://integracao.chleba.net/wsintegracao/PostPedidoStatus
Método: PostPedidoStatus
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
Order_id |
string |
Numero do Pedido |
|
Data fim |
string |
Status do PEdido |
|
|
|
|
Dados da consulta: (dados do pedido)
{
"pedidos": [
{
"order_id": "string",
"status_id": "string"
}
]
}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicavel.
{
"codigo":0,
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"mensagem":"Operação efetuada com sucesso",
"dados_adicionais":null
}
}
GetCategoria
Este método retorna todas as categorias cadastradas no sistema.
URL: http://integracao.chleba.net/wsintegracao/GetCategoria
Método: GetCategoria
PARAMETROS DE ENTRADA: (devem ser inseridos no cabeçalho)
|
Parâmetro |
Tipo |
Info Adicional |
Obrigatório |
|
Token |
String |
Sim |
|
|
login |
string |
Sim |
|
|
metodo |
String |
Sim |
Dados do Envio:
|
Informação |
Tipo |
Info Adicional |
|
categoriaid |
int |
Pesquisa por um id externo da categoria |
|
descricao |
string |
Pesquisa pela descricao da categoria |
|
|
|
|
Dados da consulta: (dados do pedido)
"GetCategoria":
{
"Categoria":{
"Categoriaid":"01",
"descricao":"Capacetes"
}
}
Exemplo de retorno:
{ mensagem: mensagem referente a resposta.
dados_adicionais: objeto ou lista com dados adicionais, quando aplicavel.
{
"codigo":0,
"ticket":"2C958E36-F2FB-4B0E-9245-2F84A54EE910",
"mensagem":"Operação efetuada com sucesso",
{
"Categorias": {
"categoria": {
"categoria_id": "9911",
"nome": "Capacetes",
}
}
}}}