Manual de Integração -...

Manual de Integração WebService Tray

Versão 3.11.1

Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP Fone: (14) 3311-8700 | www.tray.com.br

Sumário Introdução ............................................................................................................................................................. 1 1. Categoria de Produto ..................................................................................................................................... 2 2. Relacionamento de Categoria com Produto .................................................................................................. 3 3. Marca de Produto .......................................................................................................................................... 5 4. Característica de Produto ............................................................................................................................... 6 5. Perfil de Produto ............................................................................................................................................ 7 6. Relacionamento de Característica com Perfil de Produto ............................................................................. 8 7. Relacionamento de Categoria com Perfil de Produto .................................................................................... 9 8. Valor na Característica de Produto .............................................................................................................. 10 9. Produto ......................................................................................................................................................... 12 10. Produto (Cadastro Simples) ......................................................................................................................... 14 11. Variação de Produto .................................................................................................................................... 16 12. Valor na Característica de Variação de Produto .......................................................................................... 18 13. Promoção de Produto .................................................................................................................................. 19 14. Relacionamento de Promoção com Produto .............................................................................................. 20 15. Atualização de Preço de Produto ................................................................................................................ 21 16. Atualização de Disponibilidade de Produto ................................................................................................. 22 17. Atualização de Estoque de Produto............................................................................................................. 23 18. Cliente .......................................................................................................................................................... 24 19. Cadastra Contato de Cliente ........................................................................................................................ 26 20. Cadastra Endereço de Cliente ...................................................................................................................... 27 21. Importação de Pedido ................................................................................................................................. 28 22. Importação de Pedido por ID ....................................................................................................................... 30 23. Importação de Cliente ................................................................................................................................. 32 24. Importação de Cliente com Pedido ............................................................................................................. 34 25. Importação de Cliente sem Pedido ............................................................................................................. 36 26. Importação de Itens de Pedido.................................................................................................................... 38 27. Importação de Itens de Pedido Específico................................................................................................... 40 28. Importação de Parcelas de Pedido .............................................................................................................. 41 29. Importação de Parcelas de Pedido Específico ............................................................................................. 43 30. Atualização de Status de Pedido.................................................................................................................. 45 Remoção de Registro para não Sincronismo com o WebService ........................................................................ 47 31. Consulta de Status de Pedido ...................................................................................................................... 48 32. Compre Junto e Brinde ................................................................................................................................ 49 33. Produtos Relacionados ................................................................................................................................ 51 34. Cadastro de Lista de Desejo ......................................................................................................................... 52 35. Cadastro de Produtos de Lista de Desejo .................................................................................................... 54 36. Exclui Lista de Desejos ................................................................................................................................. 55 37. Exclui Produto da Lista de Desejo ................................................................................................................ 56 38. Pesquisa de Vendas da Lista de Desejo do Cliente ...................................................................................... 57 39. Busca Lista de Desejo ................................................................................................................................... 58 40. Importação de Produto por Código de Referência ...................................................................................... 60 41. Importação de Produto por Código de ID.................................................................................................... 62 42. Importação de Itens de Pedido por ID de Pedido ........................................................................................ 64 43. Importação de Parcelas de Pedido por ID de Pedido .................................................................................. 66 44. Importação de Cliente por ID de Cliente ..................................................................................................... 68 45. Importação de Cliente por E-mail de Cliente ............................................................................................... 70 46. Importação de Cliente por CPF de Cliente ................................................................................................... 72 47. Importação de Cliente por CNPJ de Cliente ................................................................................................. 74


48. Importação de Cliente sem Dados de Pedido ............................................................................................. 76 49. Relacionamento de Cliente com Perfil de Cliente ....................................................................................... 78 50. Lista de Preço de Cliente ............................................................................................................................. 79 51. Cadastro de Campos para Grupo de Imposto ............................................................................................. 80 52. Cadastro de Grupo de Imposto ................................................................................................................... 81 53. Relacionamento de Grupo de Imposto com Categorias ou Produtos ......................................................... 83 54. Atualização de Dados de Recursos Extras ................................................................................................... 85 55. Compre Junto Avançado .............................................................................................................................. 86 56. Converte Pedido em Comissão .................................................................................................................... 88 57. Importação de Variação por Código de Referência ..................................................................................... 89 58. Importação de Categoria por Nome ............................................................................................................ 90 59. Cliente (modo avançado) ............................................................................................................................. 91 60. Importação de Cliente (modo avançado) .................................................................................................... 94 61. Importação de Cliente com Pedido (modo avançado) ................................................................................ 97 62. Importação de Cliente sem Dados de Pedido (modo avançado) .............................................................. 100 63. Importação de Cliente por ID de Cliente (modo avançado) ...................................................................... 103 64. Importação de Cliente por CPF de Cliente (modo avançado) ................................................................... 106 65. Importação de Cliente por E-mail de Cliente (modo avançado) ............................................................... 109 66. Importação de Cliente por CNPJ de Cliente (modo avançado) ................................................................. 112 67. Formas de Pagamento Disponíveis ............................................................................................................ 115 68. Relacionamento de Descontos/Acréscimos Específicos por Produtos...................................................... 116 69. Cadastro/atualização de notas fiscais de pedidos ..................................................................................... 117 70. Consulta de notas fiscais de pedidos ......................................................................................................... 118


1

Introdução

O sistema Tray Commerce permite a integração via WebService. Sendo possível enviar direto de seu ERP ou

sistema de gestão os produtos, clientes, categorias, lista de casamento, características, marcas, entre outras

informações, além de integrar os pedidos da loja virtual, dessa forma sendo possível a gestão de pedidos pelo

seu sistema de ERP.

Para que seja possível realizar testes de integração junto a loja, é necessário o contato com a equipe de Vendas

para contratação do Recurso Extra em sua loja.

A integração utiliza o padrão SOAP e o WSDL poderá ser acessado em:

{URL_LOJA}/webservice/v2/ws_servidor.php?wsdl

Onde, {URL_LOJA} deverá ser alterado de acordo com a URL da loja que será feita a integração.


2

1. Categoria de Produto

A categoria é o departamento em que será demonstrado o produto na loja. Produtos sem categoria não aparecerão na loja.

Método: fWSCadastraCategoria

Parâmetros de Entrada

Campos Tipo Tamanho Obrigatório Descrição

pid_loja integer 11 Sim ID da loja

plogin string 80 Sim Login de usuário válido na ADM da loja

psenha string 80 Sim Senha do login válido na ADM da loja

id_categoria integer 11 Sim ID da categoria - "0" para incluir e ID para alterar

id_categoriapai integer 11 Sim ID da categoria principal - "0" para nenhum e ID para vínculo

descricao string 80 Sim Nome da categoria

ativo string 1 Não Liberação da categoria - pode ser: "S" ou "N"

Parâmetros de Saída


status string 2 Sim Status da operação - pode ser: "ok" ou "no"

id_categoria integer 11 Sim ID da categoria cadastrada ou alterada


3

2. Relacionamento de Categoria com Produto

Para que o produto seja exibido na loja é necessário que esteja relacionada a pelo menos uma categoria.

Método: fWSRelacionaCategProduto






id_categoria integer 11 Sim ID da categoria de produto

id_produto integer 11 Sim ID do produto

ids_categoria array - Não Array de categorias (principal e adicionais) do produto. A primeira posição é considerada a categoria principal




chaves string 50 Sim Retorno dos ID´s de categoria e produto separados por 'pipe' - ex: "123|456"

Exemplo de array do campo ‘ids_categoria’:


4

$ids_categoria[] = ID Categoria Caso a informação “id_categoria” e “ids_categoria” forem enviadas com informações preenchidas, o sistema irá considerar as informações contidas somente em “ids_categorias”. Enviando “ids_categorias” o produto terá todas as categorias a que está relaciono atualizadas, sendo possível a descategorização. Enviando somente “id_categoria” o sistema irá agrupar com as categorias que o produto já encontra-se relacionado, sem possibilidade de descategorização.


5

3. Marca de Produto

Trata-se das marcas dos produtos que serão disponibilizados na loja.

Método: fWSCadastraMarca






id_marca integer 11 Sim ID da marca - "0" para incluir e ID para alterar

descricao string 50 Sim Nome da marca

ativo string 1 Não Liberação da marca - pode ser: "S" ou "N"




id_marca integer 11 Sim ID da marca cadastrada ou alterada


6

4. Característica de Produto

Informações adicionais para produtos, que serão atreladas ao Perfil. Exemplo: ISBN, Número de páginas etc.

Método: fWSCadastraCaracteristica






id_caracteristica integer 11 Sim

ID da característica - "0" para incluir e ID para alterar - Ao enviar uma característica irá ser verificado se já existe uma característica com o mesmo nome, assim sendo retornado o ID em caso de já existir.

descricao string 50 Sim Nome da característica

ativo string 1 Não Liberação da característica - pode ser: "S" ou "N"




id_caracteristica integer 11 Sim ID da característica cadastrada ou alterada


7

5. Perfil de Produto

Cada Categoria poderá conter um perfil de características específicas de seus produtos. Por exemplo: perfil livros contém características como ISBN, Número de Páginas do Livro, Tipo de Encadernação, etc.

Método: fWSCadastraPerfil






id_perfil integer 11 Sim ID do perfil - "0" para incluir e ID para alterar

descricao string 80 Sim Nome do perfil

ativo string 1 Não Liberação do perfil - pode ser: "S" ou "N"




id_perfil integer 11 Sim ID do perfil cadastrado ou alterado


8

6. Relacionamento de Característica com Perfil de Produto

Responsável pelo relacionamento de características no perfil.

Método: fWSRelacionaCaractPerfil






id_perfil integer 11 Sim ID do perfil de produto

id_caracteristica integer 11 Sim ID da característica de produto




chaves string 50 Sim Retorno dos ID´s de perfil e característica separados por 'pipe' - ex: "123|456"


9

7. Relacionamento de Categoria com Perfil de Produto

Responsável pelo relacionamento do Perfil com a Categoria.

Método: fWSRelacionaCategPerfil






id_perfil integer 11 Sim ID do perfil de produto

id_categoria integer 11 Sim ID da categoria de produto




chaves string 50 Sim Retorno dos ID´s de perfil e categoria separados por 'pipe' - ex: "123|456"


10

8. Valor na Característica de Produto

Responsável pela atribuição de um valor para a característica. É obrigatório que o produto esteja configurado em uma Categoria onde o Perfil possua a característica configurada.

Método: fWSCadastraDadosProduto








valor string 100 Sim Valor da característica de produto




chaves string 50 Sim Retorno dos ID´s de caracteristica e produto separados por 'pipe' - ex: "123|456"


11

Para a atualização dos campos:

• DESTAQUE

• LANCAMENTO

• DISPONIVEL

• FRETE GRATIS É possível que seja feita por produto desta forma:

1. Cadastrar característica com o nome “TRAY” via Back Office a. Caminho: Back Office > Produtos > Gerenciar Características > Criar

2. Utilizar este método enviando as informações: a. Campo “id_caracteristica” = ID da característica “TRAY” criada anteriormente b. Campo “valor” = um dos campos necessários para atualização no produto


12

9. Produto

Responsável pelo cadastro/atualização dos produtos.

Método: fWSCadastraProduto






id_produto integer 11 Sim ID do produto - "0" para incluir. Caso seja enviado o ID e não existir produto cadastrado com o ID, será criado o produto com o ID enviado. Caso já exista o ID do produto na loja, irá atualizar o produto conforme ID enviado.

id_marca integer 11 Não ID da marca do produto

id_fornecedor integer 11 Não ID do fornecedor do produto

cod_referencia string 120 Sim Código de referência do produto

descricao string 200 Sim Nome do produto

descricao_curta string 500 Sim Descrição resumida do produto

custo string 15,2 Sim Valor do custo do produto em Real - formato: "0.00"

moeda_custo_aux string 10 Não Formato de moeda auxiliar - ex: "US$"

custo_auxiliar string 15,2 Não Valor do custo do produto da moeda auxiliar - formato: "0.00"

preco string 15,2 Sim Preço do produto em Real - formato: "0.00"

peso_cubico string 15,2 Sim Peso cúbico do produto em kg

peso string 15,2 Sim Peso do produto em kg

disponivel string 1 Sim Flag de disponibilidade de venda do produto - pode ser "S" ou "N"

informacao array - Sim Array com informações para geração da descrição longa nas abas corretas

garantia string 120 Não Tempo de garantia do produto - ex: 1 Ano

disponibilidade string 100 Sim Tempo de disponibilidade do produto - pode ser: "IM" para "Pronta Entrega"


13

estoque integer 11 Sim Quantidade de estoque do produto

estoque_minimo integer 11 Não Quantidade mínima de estoque do produto

prazo_entrega integer 4 Não Prazo para entrega em dias - campo não utilizado

frete_desconto string 15,2 Não Valor de desconto para freete - campo não utilizado

destaque string 1 Não Flag para setar produto em destaque - pode ser "S" ou "N"

data_cadastro string 8 Sim Data de cadastro do produto padrão japonês sem hífen - ex: "20091116"

info_preco string 100 Não Informação de parcelamento do valor do produto - campo não utilizado

ativo string 1 Sim Liberação do produto - pode ser: "S" ou "N" - caso "N" com ID: exclui registro do produto




id_produto integer 11 Sim ID do produto cadastrado ou alterado

Exemplo de array do campo ‘informacao’:

$informacao[0]['TipoNome'] = ""; $informacao[0]['Texto'] = ""; $informacao[1]['TipoNome'] = ""; $informacao[1]['Texto'] = ""; $informacao[N]['TipoNome'] = ""; $informacao[N]['Texto'] = "";

A var 'TipoNome' poderá ser exatamente:

- ITENS INCLUSOS - VIDEO - GARANTIA - DISPONIBILIDADE - DESCRICAO CURTA - TIPO PRODUTO (opções: “VIRTUAL” ou “FISICO”. Se não informado = “FISICO”)

- LANCAMENTO: Caso seja enviado este item e este possuir algum valor (“0” para não lançamento e “1” para lançamento), o sistema irá atualizar o campo. Caso esta informação não seja enviada, não haverá nenhuma atualização.


14

10. Produto (Cadastro Simples)

Responsável pelo cadastro/atualização simplificada dos produtos - campo não obrigatório nulo não atualiza informação.

Método: fWSCadastraProdutoSimples






id_produto integer 11 Sim ID do produto - "0" para incluir. Caso seja enviado o ID e não existir produto cadastrado com o ID, será criado o produto com o ID enviado. Caso já exista o ID do produto na loja, irá atualizar o produto conforme ID enviado.

cod_referencia string 120 Não Código de referência do produto

descricao string 200 Não Nome do produto

preco string 15,2 Não Preço do produto em Real - formato: "0.00"

peso string 15,2 Não Peso do produto em kg

informacao array - Não Array com informações para geração da descrição longa nas abas corretas

estoque integer 11 Não Quantidade de estoque do produto

data_cadastro string 8 Não Data de cadastro do produto padrão japonês sem hífen - ex: "20091116"

ativo string 1 Sim Liberação do produto - pode ser: "S" ou "N" - Caso "N" com ID: exclui tudo do produto


15




id_produto integer 11 Sim ID do produto cadastrado ou alterado




- ITENS INCLUSOS - VIDEO - GARANTIA - DISPONIBILIDADE - DESCRICAO CURTA


16

11. Variação de Produto

Responsável pelo cadastro de variações dos produtos. Não são cadastradas as características neste método.

Método: fWSCadastraGradeProduto






id_grade integer 11 Sim ID da variação - "0" para incluir e ID para alterar


cod_referencia string 120 Não Código de referência do produto - campo não utilizado

peso integer 11 Sim Peso da variação em Kg

peso_cubico integer 11 Sim Peso cúbico da variação em Kg

custo string 15,2 Sim Valor do custo da variação em Real - formato: "0.00"

preco string 15,2 Sim Preço da variação em Real - formato: "0.00"

estoque integer 11 Sim Estoque da variação

ativo string 1 Sim Liberação da variação - pode ser: "S" ou "N" - Caso "N" com ID da grade: exclui variação


17




id_grade integer 11 Sim ID da variação cadastrada ou alterada


18

12. Valor na Característica de Variação de Produto

Responsável pelo cadastro das características das variações. Para o cadastro de variação dupla deverá ser enviado o id distinto de características para um mesmo id de grade.

Método: fWSCadastraVariaProdutos






id_grade integer 11 Sim ID da variação


valor string 200 Sim Valor da característica de variação

ativo string 1 Não Liberação da característica de variação - pode ser: "S" ou "N"




chaves string 50 Sim Retorno dos ID´s de variação e caracteristica separados por 'pipe' - ex: "123|456"


19

13. Promoção de Produto

Responsável pelo cadastro de promoções específicas da loja.

Método: fWSCadastraPromocao






id_promocao integer 11 Sim ID da promoção - "0" para incluir e ID para alterar

descricao string 50 Sim Nome da promoção

data_inicial string 10 Sim Data inicial da promoção em padrão japonês - ex: "2009-11-16"

data_final string 10 Sim Data final da promoção em padrão japonês - ex: "2010-11-16"

ativo string 1 Não Liberação da promoção - pode ser: "S" ou "N"




id_promocao integer 11 Sim ID da promoção cadastrada ou alterada


20

14. Relacionamento de Promoção com Produto

Responsável pelo atrelamento de produto a uma promoção específica da loja.

Método: fWSRelacionaPromoProduto







id_promocao integer 11 Sim ID da promoção

preco_promocao string 15,2 Sim Preço do produto em promoção em Real - formato: "0.00"




chaves string 50 Sim Retorno dos ID´s de promoção e produto por 'pipe' - ex: "123|456"


21

15. Atualização de Preço de Produto

Responsável pela atualização dos preços dos produtos. Poderão também ser registrados valores de promoção sem atrelamento a Promoções especiais.

Método: fWSAtualizaPrecoProduto






is_grade string 1 Sim Flag para identificação de variação - pode ser: "S" ou "N" ("S" = ID da variação e "N" = ID do produto)

id_produto integer 11 Sim ID do produto ou ID da variação - conforme flag 'is_grade'


precopromo string 15,2 Sim Preço em promoção do produto em Real - formato: "0.00"

data_inicio string 10 Não Data inicial de promoção em padrão japonês - ex: "2009-11-16"

data_termino string 10 Não Data final de promoção em padrão japonês - ex: "2009-11-16"




id_produto integer 11 Sim ID do produto alterado

Observação: Quando um produto possuir variações, sempre será atribuído ao valor do produto principal (pai) o menor preço das variações que possuam estoque, mesmo que seja enviado um valor diferenciado para o produto principal.


22

16. Atualização de Disponibilidade de Produto

Responsável por alterar a disponibilidade (disponível ou não disponível) de produto específico.

Método: fWSAtualizaProdutoDisponivel







disponivel integer 1 Sim Flag de disponibilidade - pode ser: “0” para não disponível ou “1” para disponível






23

17. Atualização de Estoque de Produto

Responsável pela atualização do estoque dos produtos.

Método: fWSAtualizaEstoqueProduto






is_grade string 1 Sim Flag para identificação de variação - pode ser: "S" ou "N" ("S" = ID da variação e "N" = ID do produto)

id_produto integer 11 Sim ID do produto ou ID da variação - conforme flag 'is_grade'

estoque integer 11 Sim Quantidade de estoque do produto

estoque_minimo integer 11 Sim Quantidade mínima de estoque do produto





Observação: Quando um produto possuir variações, sempre será atribuído ao estoque do produto principal (pai) a soma de todas os estoques das variações disponíveis, mesmo que seja enviado uma quantidade diferenciada de estoque para o produto principal.


24

18. Cliente

Responsável pelo cadastro de novos clientes na loja.

Método: fWSCadastraCliente






id_cliente integer 11 Sim ID do cliente - "0" para incluir e ID para alterar

id_pais integer 11 Não ID do país do endereço - campo não utilizado

id_revenda integer 11 Não ID de cliente revenda - campo não utilizado

tipo_pessoa string 1 Sim Tipo de pessoa: "F" para pessoa física e "J" para pessoa jurídica

bloqueado string 1 Sim Liberação do cadastro do cliente - pode ser: "S" ou "N"

nome string 300 Sim Nome do cliente

cnpf_cpf string 30 Sim CNPJ ou CPF - depende do tipo de pessoa

ie_rg string 30 Sim Inscrição Estadual ou RG - depende do tipo de pessoa

data_nasc string 10 Sim Data de nascimento em padrão japonês - ex: "2009-11-16"

data_cadastro string 10 Sim Data do cadastro em padrão japonês - ex: "2009-11-16"

email string 100 Sim Email do cliente - usado para login na loja

senha string 100 Sim Senha do cliente - usado para login na loja

observacao string - Sim Breve observação referente ao cliente

ativo string 1 Não Liberação do cliente - pode ser: "S" ou "N"

id_perfil integer 11 Não ID do perfil de cliente

limite_credito_perfil string 15,2 Não Valor do limite de crédito do cliente em Real - formato: "0.00"


25

id_cliente_pai integer 11 Não ID do cliente pai - pode ser: “0” para cliente principal ou “id_cliente” para relacionar ao cliente principal




id_cliente integer 11 Sim ID do cliente cadastrado ou alterado

Observações sobre 2 campos de entrada:

• Campo ‘id_perfil’ é utilizado pelo Recurso Extra: Perfil de Clientes;

• Campo ‘limite_credito_perfil’ é utilizado pelo Recurso Extra: Perfil de Clientes;

• Campo ‘id_cliente_pai’ é utilizado pelo Recurso Extra: Nível de Cadastro de Clientes.


26

19. Cadastra Contato de Cliente

Responsável pelo cadastro de contato de cliente na loja.

Método: fWSCadastraContatosCliente







telefone string 15 Sim Formatos aceitos: 999999999, 99999999999, (99) 9999-9999 e (99) 99999-9999

telefone_adicional string 15 Sim Formatos aceitos: 999999999, 99999999999, (99) 9999-9999 e (99) 99999-9999





27

20. Cadastra Endereço de Cliente

Responsável pelo cadastro de endereço de cliente na loja.

Método: fWSCadastraEnderecoCliente







logradouro string 300 Sim Nome da rua do endereço do cliente

numero string 10 Sim Número do endereço do cliente

bairro string 200 Sim Bairro do cliente

complemento string 200 Sim Complemento do endereço do cliente

cidade string 200 Sim Cidade do cliente

estado string 2 Sim UF do endereço do cliente

cep integer 8 Sim CEP do cliente - formato aceito: 99999999 (sem “traço”)

pais string 50 Sim País do cliente





28

21. Importação de Pedido

Disponibilização de todos os dados de pedidos pendentes de sincronização. Após sincronização (pedido, itens de pedidos e parcelas), deverá ser removido da lista de pedidos pendentes (fWSAtualizaListaToDo - entidade: pedidos).

Método: fWSImportaPedidos






data_inicial string 10 Não Data inicial de cadastro em padrão japonês - ex: "2009-11-16" - campo não utilizado

data_final string 10 Não Data final de cadastro em padrão japonês - ex: "2009-11-16" - campo não utilizado

hora_inicial string 4 Não Hora e minuto inicial de cadastro (somente números) - ex: "1230" - campo não utilizado

hora_final string 4 Não Hora e minuto final de cadastro (somente números) - ex: "2354" - campo não utilizado

status_atual string 100 Não Status de pedidos - vazio para todos os status

tipo_pedido string 1 Não Tipo de venda: “ ” (vazio): venda e orçamento / “0”: venda / “1”: orçamento



id_pedido integer 11 Sim Código do pedido

pedido_nfin integer 11 Não Número de pedido final - campo sem retorno

frete string 50 Sim Frete escolhido no pedido

id_cliente integer 11 Sim ID do cliente

id_orcamento integer 11 Não ID do orçamento - campo sem retorno

id_site_parceiro integer 11 Não ID do site parceiro - campo sem retorno

id_local_venda integer 11 Não ID do local de venda - campo sem retorno


29

id_usuario integer 11 Não ID do usuário da operação - campo sem retorno

data_pedido string 10 Sim Data do pedido em padrão japonês - ex: "2009-11-16"

hora_pedido string 4 Sim Hora do pedido (somente números) - ex: "1230"

data_envio string 10 Sim Data do envio do pedido em padrão japonês - ex: "2009-11-16"

hora_envio string 4 Não Hora do envio do pedido (somente números) - ex: "1230" - campo sem retorno

ip_origem string 15 Sim IP da origem do pedido

total string 15,2 Sim Total da soma dos produtos do pedido - formato: "0.00"

desconto string 15,2 Não Valor total de desconto - cupom, cliente revenda e forma de pagamento - formato: "0.00"

valor_cupom string 15,2 Não Valor de cupom de desconto do pedido - formato: "0.00"

comissao string 15,2 Não Valor total de comissão - formato: "0.00"

valor_frete string 15,2 Sim Valor do frete escolhido - formato: "0.00"

frete_pago string 1 Não Flag para identificação de frete pago - campo sem retorno

cod_rastreamento string 200 Sim Código de envio do pedido

obs_loja string - Sim Observação da loja no pedido

obs_cliente string - Sim Observação do cliente no pedido (finalização de compra)

obs_pagamento string 200 Não Observação de pagamento no pedido - campo sem retorno

obs_frete string 200 Não Observação de frete - campo sem retorno

valor_imposto string 15,2 Sim Valor total de imposto e acréscimo de forma de pagamento - formato: "0.00"

valor_embalagem string 15,2 Não Valor de embalagem de presente - campo sem retorno

local_venda string 100 Sim Local da venda do pedido - ex: "LOJA VIRTUAL"

nro_cupom string 100 Não Número ou nome do cupom de desconto

parceiro string 200 Não Nome do parceiro da loja que originou o pedido

status string 100 Não Status do pedido

tipo_pedido string 1 Não Tipo de venda: “0”: venda / “1”: orçamento


30

22. Importação de Pedido por ID

Disponibilização de todos os dados de um pedido específico.

Método: fWSImportaPedidoPorId






id_pedido integer 11 Sim ID do pedido para captura de dados




pedido_nfin integer 11 Não Número de pedido final - campo sem retorno

frete string 50 Sim Frete escolhido no pedido


id_orcamento integer 11 Não ID do orçamento - campo sem retorno

id_site_parceiro integer 11 Não ID do site parceiro - campo sem retorno

id_local_venda integer 11 Não ID do local de venda - campo sem retorno

id_usuario integer 11 Não ID do usuário da operação - campo sem retorno

data_pedido string 10 Sim Data do pedido em padrão japonês - ex: "2009-11-16"

hora_pedido string 4 Sim Hora do pedido (somente números) - ex: "1230"

data_envio string 10 Sim Data do envio do pedido em padrão japonês - ex: "2009-11-16"

hora_envio string 4 Não Hora do envio do pedido (somente números) - ex: "1230" - campo sem retorno


31

ip_origem string 15 Sim IP da origem do pedido

total string 15,2 Sim Total da soma dos produtos do pedido - formato: "0.00"

desconto string 15,2 Não Valor total de desconto - cupom, cliente revenda e forma de pagamento - formato: "0.00"

valor_cupom string 15,2 Não Valor de cupom de desconto do pedido - formato: "0.00"

comissao string 15,2 Não Valor total de comissão - formato: "0.00"

valor_frete string 15,2 Sim Valor do frete escolhido - formato: "0.00"

frete_pago string 1 Não Flag para identificação de frete pago - campo sem retorno

cod_rastreamento string 200 Sim Código de envio do pedido

obs_loja string - Sim Observação da loja no pedido

obs_cliente string - Sim Observação do cliente no pedido (finalização de compra)

obs_pagamento string 200 Não Observação de pagamento no pedido - campo sem retorno

obs_frete string 200 Não Observação de frete - campo sem retorno

valor_imposto string 15,2 Sim Valor total de imposto e acréscimo de forma de pagamento - formato: "0.00"

valor_embalagem string 15,2 Não Valor de embalagem de presente - campo sem retorno

local_venda string 100 Sim Local da venda do pedido - ex: "LOJA VIRTUAL"

nro_cupom string 100 Não Número ou nome do cupom de desconto

parceiro string 200 Não Nome do parceiro da loja que originou o pedido


tipo_pedido string 1 Não Tipo de venda: “0”: venda / “1”: orçamento


32

23. Importação de Cliente

Disponibilização de todos os clientes que possuem pedidos pendentes de sincronização. Após sincronização, deverá ser removido da lista de clientes pendentes (fWSAtualizaListaToDo - entidade: clientes).

Método: fWSImportaClientes













id_pedido integer 11 Sim ID do pedido


pais string 100 Sim Nome do país do cadastro do cliente

revenda string 250 Sim Nome do cliente ou Razão Social ou vazia - depende do tipo de pessoa



cliente string 300 Sim Nome do cliente ou Razão Social - depende do tipo de pessoa

cnpj_cpf string 30 Sim CNPJ ou CPF - depende do tipo de pessoa


33






logradouro string 200 Sim Endereço do cliente


bairro string 100 Sim Bairro do endereço do cliente


cep string 8 Sim CEP do endereço - somente números - ex: "17500140"


uf string 2 Sim UF do cliente

telefone string 100 Sim Número de telefone do cliente

fax string 100 Sim Número de fax do cliente

celular string 100 Sim Número de celular do cliente

sexo string 1 Sim Sexo: "M" para masculino e "F" para feminino






34

24. Importação de Cliente com Pedido

Disponibilização de todos os clientes que possuem pedidos na loja virtual.

Método: fWSImportaClientesComPedido






















35






















36

25. Importação de Cliente sem Pedido

Disponibilização de todos os clientes que não possuem pedidos na loja virtual.

Método: fWSImportaClientesSemDadosPedido






















37






















38

26. Importação de Itens de Pedido

Serão enviados nesse método todos os produtos comprados do pedido pendente de sincronização.

Método: fWSImportaItensPedidos















id_grade integer 11 Não ID da variação - campo sem retorno

id_kit integer 11 Não ID do kit de produto - campo sem retorno

id_embalagem integer 11 Não ID da embalagem do produto - campo sem retorno

id_lista integer 11 Não ID Lista de Desejos

nome_produto string 100 Não Nome do produto comprado

referencia string 100 Não Referência do produto comprado


39

preco string 15,2 Sim Valor do produto vendido - formato: "0.00"

custo string 15,2 Não Valor do custo do produto vendido - formato: "0.00"

comissao string 15,2 Não Valor de comissão referente ao produto vendido

quantidade integer 11 Sim Quantidade de produto vendido


brinde integer 1 Não Identificação se o produto é um brinde. Formato: “0” para não, “1” para sim


40

27. Importação de Itens de Pedido Específico

Este método faz a importação de itens (produtos) de um pedido específico.

Método: fWSImportaItensPedidoPorId






id_pedido integer 11 Sim ID do pedido para captura de itens do pedido















41

28. Importação de Parcelas de Pedido

Será realizado o envio das informações de formas de pagamento de um pedido em especifico, sendo informada a forma de pagamento. No caso de parcelamento, as parcelas com seus respectivos valores.

Método: fWSImportaParcelasPedidos








hora_inicial integer 4 Não Hora e minuto inicial de cadastro (somente números) - ex: "1230" - campo não utilizado

hora_final integer 4 Não Hora e minuto final de cadastro (somente números) - ex: "2354" - campo não utilizado




id_parcela integer 11 Sim ID da parcela (ID do pedido concatenado com o contador da parcela)


forma_pagamento string 150 Sim Nome da forma de pagamento

data_vencimento string 10 Sim Data do vencimento da parcela em padrão japonês - ex: "2009-11-16"

valor string 15,2 Sim Valor da parcela em Real - formato: "0.00"

data_pagamento date 10 Não Data do pagamento da parcela

data_confirmacao date 10 Não Data de confirmação da parcela - mesma data do pagamento da parcela

valor_pago string 15,2 Não Valor pago do pedido em Real - formato: "0.00"


42

local_pagamento string 150 Sim Local de pagamento do pedido

observacao string - Sim Observação de pagamento

id_forma_pagamento integer 11 Sim ID da forma de pagamento

qt_parcelas integer 4 Sim Número de parcelas do pedido



43

29. Importação de Parcelas de Pedido Específico

Este método faz a importação de parcelamento de um pedido específico.

Método: fWSImportaParcelasPedidoPorId






id_pedido integer 11 Sim ID do pedido para captura de parcelamentos








data_pagamento date 10 Não Data do pagamento da parcela

data_confirmacao date 10 Não Data de confirmação da parcela - mesma data do pagamento da parcela





qt_parcelas string 4 Sim Número de parcelas do pedido


44



45

30. Atualização de Status de Pedido

Poderá ser realizada a alteração de um status de pedido junto a loja virtual, dessa forma sendo demonstrado ao cliente o status alterado. Para alterar somente o status de um pedido, é necessário que obrigatoriamente envie o numero do pedido e o id do status. Cada loja virtual contém seus status e seus ids de status. Alguns exemplos: ID 1 - A ENVIAR, ID 22 - AGUARDANDO CONFIRMACAO DO PAGAMENTO, ID 69 - FINALIZADO.

Método: fWSAtualizaStatusPedidos






lista_status array - Sim Variável tipo 'array' com dados obrigatórios para alteração do status de pedido




id_pedido integer 11 Sim Código do pedido alterado


46

Exemplos de array do campo ‘lista_status’: $lista_status['protocolo'] = "";

$lista_status['pedido'] = 2;

$lista_status['id_status'] = 59;

$lista_status['status'] = "";

$lista_status['Data'] = "";

$lista_status['Hora'] = "";

ou $lista_status[0]['protocolo'] = "";

$lista_status[0]['pedido'] = 2;

$lista_status[0]['id_status'] = 59;

$lista_status[0]['status'] = "";

$lista_status[0]['Data'] = "";

$lista_status[0]['Hora'] = "";


47

Remoção de Registro para não Sincronismo com o WebService

Trata-se da fila de clientes e pedidos disponíveis para sincronização. Após sincronização é necessário a solicitação do método para que o registro seja removido e não mais enviado para sincronização.

Método: fWSAtualizaListaToDo






entidade string 100 Sim Nome da tabela no banco de dados - pode ser: "pedidos" ou "clientes"

id integer 11 Sim ID do registro no banco de dados - pode ser o código do pedido ou ID do cliente




id integer 11 Sim ID do registro no banco de dados


48

31. Consulta de Status de Pedido

Método que retorna o Status atual do pedido.

Método: fWSConsultaStatusPedido






id_pedido integer 11 Sim ID do pedido para consulta de Status




status_pedido string 11 Não Status do pedido consultado - caso não encontre o pedido, o retorno é nulo

id_pedido integer 11 Sim ID do pedido consultado


49

32. Compre Junto e Brinde

Método para cadastro e manutenção de itens do Compre Junto. Para brinde, o produto deverá ter tal marcação em seu atrelamento.

Método: fWSCadastraCompreJunto






id_produto integer 11 Sim ID do produto principal

data_inicial string 10 Sim Data inicial de validade do Compre Junto / Brinde padrão japonês sem hífen - ex: "20091116"

data_final string 10 Sim Data final de validade do Compre Junto / Brinde padrão japonês sem hífen - ex: "20091116"

brinde integer 1 Sim Informativo indicando se o relacionamento é para Compre Junto (=0) ou Brinde (=1)

compre_junto array - Sim Array de informações referente ao produto do Compre Junto




id_compre_junto integer 11 Não ID do Compre Junto adicionado ou atualizado



50

Exemplo de array do campo ‘compre_junto’:

$compre_junto[0]['produto'] = (ID do produto pertencente ao Compre Junto);

$compre_junto[0]['tipo_desconto'] = (0 para R$ / 1 para %);

$compre_junto[0]['desconto'] = (Valor do desconto para o Compre Junto).


51

33. Produtos Relacionados

Método para cadastro e manutenção de itens dos Produtos Relacionados.

Método: fWSRelacionaProduto







produtos_relacionados array - Sim Array de produtos relacionados. Até 4 posições.





id_produtos_relacionados string - Sim ID dos produtos relacionado ao produto principal, utilizando o formato “1|2|3|4” (separados por pipe “|”)

Exemplo de array do campo ‘produtos_relacionados’:

$produtos_relacionados[] = ID Produto Relacionado


52

34. Cadastro de Lista de Desejo

Método para cadastro e alteração de lista de desejo.

Método: fWSCadastraListaDesejos






valoresLista array - Sim Array parâmetros a serem inseridos ou atualizados na lista.




id_lista integer 11 Sim ID lista


53

Exemplo de array do campo ‘valoresLista’:

$valoresLista[‘id’] = ID Lista em caso de alteração

$valoresLista[‘id_cliente’] = ID Cliente

$valoresLista[‘id_eventos’] = ID eventos.

$valoresLista[‘cliente_enderecos’] = ID endereço do Cliente

$valoresLista[‘data’] = Data do Evento

$valoresLista[‘data_cadastro’] = Data do Cadastro

$valoresLista[‘nome’] = Nome da Lista

$valoresLista[‘staus’] = 1 – Ativa ou 0 - Inativa

$valoresLista[‘data_fanalizado’] = Término prazo lista

$valoresLista[‘cartao’] = 1 – Recebe ou 0 – Não recebe

$valoresLista[‘url’] = url de acesso da lista

$valoresLista[‘recebimento’] = 0 – Vpv 0u 1 – após o fechamento

$valoresLista[‘envia _email’] = 0 – Não ou 1 – Sim

$valoresLista[‘mensagem’] = Mensagem a ser exibida na lista


54

35. Cadastro de Produtos de Lista de Desejo

Método para cadastro e alteração de produtos em determinada lista de desejo.

Método: fWSCadastraListaProdutos






dados_lista array - Sim Array parâmetros a serem inseridos ou atualizados na lista.




id integer 11 Sim ID lista

Exemplo de array do campo ‘dados_lista’:

$produtoLista['id'] = Necessário passar o ID em caso de alteração;

$produtoLista['id_lista'] = ID Lista;

$produtoLista['id_produto'] = ID Produto;

$produtoLista['quantidade'] = Quantidade;

$produtoLista['id_grade'] = ID da grade da variação;

$produtoLista['quantidade_comprada'] = Quantidade já adquirida.


55

36. Exclui Lista de Desejos

Método para exclusão de lista de desejos.

Método: fWSExcluiListaDesejos






id_lista integer 11 Sim ID da lista a ser excluída




id integer 11 Sim ID lista


56

37. Exclui Produto da Lista de Desejo

Método para exclusão de produtos de lista de desejo.

Método: fWSExcluirProdutoLista






idProdLista integer 11 Sim ID do produto





57

38. Pesquisa de Vendas da Lista de Desejo do Cliente

Método de busca de vendas em lista de desejo de determinado cliente.

Método: fWSBuscavendaListas






id_lista integer 11 Não ID lista

id_cliente integer 11 Não ID cliente



resultado array - Sim Array da consulta


58

39. Busca Lista de Desejo

Método de busca de lista de desejo.

Método: fWSBuscaListas






idLista integer 11 Não ID lista



id_lista integer 11 Sim ID da Lista

quantidade integer 11 Sim Quantidade solicitada

quantidade_comprada integer 11 Sim Quantidade Adquirida

nome_produto string 80 Sim Nome do Produto


variacao integer 11 Não ID da variação do Produto se possuir


59

Exemplo de parâmetros de saída:

Array

(

[0] => Array

(

[id_lista] => 2

[quantidade] => 3

[quantidade_comprada] => 1

[nome_produto] => A2 - Best Ever

[id_produto] => 2

[variacao] => 2

)

)


60

40. Importação de Produto por Código de Referência

Disponibilização dos dados de produto conforme o código de referência.

Método: fWSImportaProdutoPorCodReferencia






cod_referencia string 11 Sim Código de referência de produto




id_marca integer 11 Sim ID da marca do produto











61



estoque string 11 Sim Quantidade de estoque do produto

estoque_minimo string 11 Não Quantidade mínima de estoque do produto









62

41. Importação de Produto por Código de ID

Disponibilização dos dados de produto conforme o Id do produto

Método: fWSImportaProdutoPorID






Id_produto integer 11 Sim Id do produto cadastrado na plataforma Tray




id_marca integer 11 Sim ID da marca do produto












63


estoque string 11 Sim Quantidade de estoque do produto

estoque_minimo string 11 Não Quantidade mínima de estoque do produto









64

42. Importação de Itens de Pedido por ID de Pedido

Disponibilização dos dados de pedido conforme o ID do pedido. Após sincronização (pedido, itens de pedidos e parcelas), deverá ser removido da lista de pedidos pendentes (fWSAtualizaListaToDo - entidade: pedidos).

Método: fWSImportaItensPedidosPorId





















65


66

43. Importação de Parcelas de Pedido por ID de Pedido

Disponibilização dos dados de pagamento de pedido conforme o ID do pedido. Após sincronização (pedido, itens de pedidos e parcelas), deverá ser removido da lista de pedidos pendentes (fWSAtualizaListaToDo - entidade: pedidos).

Método: fWSImportaParcelasPedidoPorId














data_pagamento string 10 Não Data do pagamento da parcela

data_confirmacao string 10 Não Data de confirmação da parcela - mesma data do pagamento da parcela






67

qt_parcelas string 4 Sim Número de parcelas do pedido



68

44. Importação de Cliente por ID de Cliente

Disponibilização dos dados de cliente conforme o ID do cliente.

Método: fWSImportaClientePorId





















69
















70

45. Importação de Cliente por E-mail de Cliente

Disponibilização dos dados de cliente conforme o e-mail do cliente.

Método: fWSImportaClientePorEmail






email string 250 Sim E-mail do cliente















71
















72

46. Importação de Cliente por CPF de Cliente

Disponibilização dos dados de cliente conforme o CPF do cliente.

Método: fWSImportaClientePorCPF






cpf string 15 Sim CPF do cliente - pode conter pontuação















73
















74

47. Importação de Cliente por CNPJ de Cliente

Disponibilização dos dados de cliente conforme o CNPJ do cliente.

Método: fWSImportaClientePorCNPJ






cnpj string 18 Sim CNPJ do cliente - pode conter pontuação















75
















76

48. Importação de Cliente sem Dados de Pedido

Disponibilização de todos os clientes pendentes de atualização sem dados de pedido.

Método: fWSImportaClientesSemDadosPedido






















77

















78

49. Relacionamento de Cliente com Perfil de Cliente

Método que faz o relacionamento de cliente ao perfil de cliente.

Método: fWSRelacionaClientePerfil







id_perfil integer 11 Sim ID do perfil de cliente





id_perfil integer 11 Sim ID do perfil de cliente


79

50. Lista de Preço de Cliente

Método que faz o cadastro ou atualização da lista de preço de cliente.

Método: fWSCadastraListaPreco






id_lista integer 11 Sim ID da lista de preço - "0" para incluir e ID para alterar

nome_lista string 100 Sim Nome da lista de preço

id_produtos_precos array - Sim Array com ID´s dos produtos e valores para inclusão ou atualização na lista de preço




id_lista integer 11 Sim ID da lista de preço

Exemplo de array do campo de entrada ‘id_produtos_precos’:

$id_produtos_precos[0]['id'] = ID de produto ou ID da variação de produto $id_produtos_precos[0]['variacao'] = Caso for “0”: $id_produtos_precos[0]['id'] é ID de produto; caso for “1”: $id_produtos_precos[0]['id'] é ID de variação $id_produtos_precos[0]['valor'] = Valor do produto ou variação $id_produtos_precos[1]['id'] $id_produtos_precos[1]['variacao'] $id_produtos_precos[1]['valor']


80

51. Cadastro de Campos para Grupo de Imposto

Método que será utilizado para cadastrar/atualizar os campos que irão aceitar os valores para o grupo de impostos.

Método: fWSCadastraCamposGrupoImposto






id_campo integer 11 Sim ID do campo de imposto - "0" para incluir e ID para alterar

nome_campo string 50 Sim Nome do campo

tipo_campo integer 1 Sim Tipo do campo de imposto - “1” para produto e “2” para cliente

valor_cliente_loja integer 1 Não Flag para definição de preenchimento de valor - somente enviar caso o campo seja do tipo cliente, onde irá definir se o cliente preenche o campo na loja ou não - “1” para Sim e “2” para Não

tipo_valor_campo integer 1 Sim Tipo de valor do campo - “1” para percentual e “2” para valor em Reais




id_campo integer - Sim ID do campo de imposto


81

52. Cadastro de Grupo de Imposto

Método que será utilizado para cadastrar os grupos de impostos e o valor dos campos de imposto. O valor dos campos deverá ser inteiro, mas irá respeitar se é percentual ou valor fixo.

Método: fWSCadastraGrupoImposto






id_grupo integer 11 Sim ID do grupo de imposto - "0" para incluir e ID para alterar

nome_grupo string 100 Sim Nome do grupo

icms_proprio string 15,2 Sim Valor do ICMS próprio para o grupo de imposto

status string 0 ou 1 Sim Status do Grupo

campos_grupo array - Sim Array com os ID´s dos campos e seu valor




id_grupo integer 11 Sim ID do grupo de imposto


82

Exemplo de entrada do Array do campo “campos_grupo”:

$campos_grupo[0]['id_campo'] = "";

$campos_grupo[0]['estado'] = "";

$campos_grupo[0]['interior'] = "";

$campos_grupo[0]['capital'] = "";

$campos_grupo[0]['valor_campo'] = "";

Os estados devem ser enviados somente a sigla, exemplo: SP


83

53. Relacionamento de Grupo de Imposto com Categorias ou Produtos

Método que será utilizado para relacionar o grupo de imposto para categorias ou produtos específicos. Caso não seja feito esse relacionamento, será adquirido para todos os produtos o grupo padrão.

Método: fWSRelacionaImposto






grupo_id integer 11 Sim ID do grupo de imposto - "0" para incluir e ID para alterar

tipo_id integer 1 Sim Flag para definição do tipo do ID - “1” para ID de produto ou “2” para ID de categoria

ids_relacionamento array - Sim ID´s dos produtos ou categorias relacionadas




grupo_id integer 11 Sim Id do grupo relacionado


84

Exemplo de entrada do Array do campo “ids_relacionamento”:

$ids_relacionamento[0]['tipo_id'] = "";

$ids_relacionamento[0]['ids'] = "";

$ids_relacionamento[0]['id_grupo'] = "";

$ids_relacionamento[1]['tipo_id'] = "";

$ids_relacionamento[1]['ids'] = "";

$ids_relacionamento[1]['id_grupo'] = "";


85

54. Atualização de Dados de Recursos Extras

Parametriza valores dinamicamente de recursos extras.

Método: fWSDadosRecursosExtras






id_registro integer 11 Sim ID do registro para alteração (produto ou variação)

entidade string 30 Sim Nome do alvo para alteração - pode ser: “produtos” ou “grade”

campo string 30 Sim Nome do campo que será realizado a alteração

valor string 255 Sim Valor do campo para alteração




id_registro integer 11 Não ID do registro alterado

entidade string 30 Não Nome do alvo alterado

Parâmetros aceitos no “campo” para alteração: dimensao:largura dimensao:altura dimensao:comprimento ean


86

55. Compre Junto Avançado

Método para cadastro e manutenção de produtos ilimitados com possibilidade de incluir o título do Compre Junto.

Método: fWSCadastraCompreJuntoAvancado







data_inicial string 10 Sim Data inicial de validade do Compre Junto / Brinde padrão japonês sem hífen - ex: "20091116"

data_final string 10 Sim Data final de validade do Compre Junto / Brinde padrão japonês sem hífen - ex: "20091116"

nome string 80 Sim Nome (título) do pacote dos produtos do Compre Junto

brinde integer 1 Sim Informativo indicando se o relacionamento é para Compre Junto (=0) ou Brinde (=1)

compre_junto array - Sim Array de informações referente ao produto do Compre Junto




id_compre_junto integer 11 Não ID do Compre Junto adicionado ou atualizado



87

Exemplo de array do campo ‘compre_junto’:

$compre_junto[0]['produto'] = (ID do produto pertencente ao Compre Junto);

$compre_junto[0]['tipo_desconto'] = (0 para R$ / 1 para %);

$compre_junto[0]['desconto'] = (Valor do desconto para o Compre Junto).


88

56. Converte Pedido em Comissão

Método que converte o pedido em comissão para o recurso de Lista de Desejo.

Método: fWSConvertePedidoComissao






id_pedido integer 11 Sim ID do pedido para converter em crédito






89

57. Importação de Variação por Código de Referência

Método que faz a importação de variação pelo código de referência.

Método: fWSImportaGradePorCodReferencia






cod_referencia string 80 Sim Código de referência da variação



id_grade integer 11 Sim ID da variação do produto



90

58. Importação de Categoria por Nome

Método que faz a importação de categoria de acordo com o nome (descrição).

Método: fWSImportaCategoriaPorDescricao






id_categoriapai integer 11 Sim ID da categoria principal

descricao string 255 Não Nome da categoria principal



id_categoria integer 11 Sim ID da categoria relacionada

id_categoriapai integer 11 Sim ID da categoria principal


91

59. Cliente (modo avançado)

Responsável pelo cadastro de novos clientes na loja, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSCadastraClienteAvancado







id_pais integer 11 Não ID do país do endereço - campo não utilizado

id_revenda integer 11 Não ID de cliente revenda - campo não utilizado



nome string 300 Sim Nome do cliente

cnpf_cpf string 30 Sim CNPJ ou CPF - depende do tipo de pessoa





senha string 100 Sim Senha do cliente - usado para login na loja


ativo string 1 Não Liberação do cliente - pode ser: "S" ou "N"




92


desconto_revenda string 15,2 Não Valor de desconto para o cliente revendedor

enderecos array - Sim Dados de endereços: Obrigatório: dados de endereço de entrega / Opcional: dados de endereço de cobrança




id_cliente integer 11 Sim ID do cliente cadastrado ou alterado

Observações sobre campos de entrada:

• Campo ‘id_perfil’ é utilizado pelo Recurso Extra: Perfil de Clientes;

• Campo ‘limite_credito_perfil’ é utilizado pelo Recurso Extra: Perfil de Clientes;

• Campo ‘id_cliente_pai’ é utilizado pelo Recurso Extra: Nível de Cadastro de Clientes.


93

Exemplo de array do campo ‘enderecos’:

$enderecos[0]['tipo'] = “ENTREGA”; $enderecos[0]['logradouro'] = (nome da rua); $enderecos[0]['numero'] = (número da residencia); $enderecos[0]['complemento'] = (complemento do endereço); $enderecos[0]['bairro'] = (bairro do endereço); $enderecos[0]['cidade'] = (cidade do endereço); $enderecos[0]['uf'] = (estado do endereço); $enderecos[0]['cep'] = (cep do endereço); $enderecos[0]['pais'] = (país do endereço); $enderecos[0]['descricao'] = (campo não utilizado); $enderecos[1]['tipo'] = “COBRANCA”; $enderecos[1]['logradouro'] = (nome da rua); $enderecos[1]['numero'] = (número da residencia); $enderecos[1]['complemento'] = (complemento do endereço); $enderecos[1]['bairro'] = (bairro do endereço); $enderecos[1]['cidade'] = (cidade do endereço); $enderecos[1]['uf'] = (estado do endereço); $enderecos[1]['cep'] = (cep do endereço); $enderecos[1]['pais'] = (país do endereço); $enderecos[1]['descricao'] = (campo não utilizado).


94

60. Importação de Cliente (modo avançado)

Disponibilização de todos os clientes que possuem pedidos pendentes de sincronização, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega. Após sincronização, deverá ser removido da lista de clientes pendentes (fWSAtualizaListaToDo - entidade: clientes).

Método: fWSImportaClientesAvancado






















95























dados_extras array - Não Dados adicionais de clientes


96


$enderecos[0]['tipo'] = “ENTREGA”; $enderecos[0]['logradouro'] = (nome da rua); $enderecos[0]['numero'] = (número da residencia); $enderecos[0]['complemento'] = (complemento do endereço); $enderecos[0]['bairro'] = (bairro do endereço); $enderecos[0]['cidade'] = (cidade do endereço); $enderecos[0]['uf'] = (estado do endereço); $enderecos[0]['cep'] = (cep do endereço); $enderecos[0]['pais'] = (país do endereço); $enderecos[0]['descricao'] = (campo não utilizado); $enderecos[1]['tipo'] = “COBRANCA”; $enderecos[1]['logradouro'] = (nome da rua); $enderecos[1]['numero'] = (número da residencia); $enderecos[1]['complemento'] = (complemento do endereço); $enderecos[1]['bairro'] = (bairro do endereço); $enderecos[1]['cidade'] = (cidade do endereço); $enderecos[1]['uf'] = (estado do endereço); $enderecos[1]['cep'] = (cep do endereço); $enderecos[1]['pais'] = (país do endereço); $enderecos[1]['descricao'] = (campo não utilizado). Exemplo de array do campo ‘dados_extras:

$dados_extras[0]['campo'] = (informação adicional preenchida pelo cliente); $dados_extras[0]['valor'] = (valor da informação adicional preenchida pelo cliente).


97

61. Importação de Cliente com Pedido (modo avançado)

Disponibilização de todos os clientes que possuem pedidos na loja virtual, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSImportaClientesComPedidoAvancado






















98


























99




100

62. Importação de Cliente sem Dados de Pedido (modo avançado)

Disponibilização de todos os clientes pendentes de atualização sem dados de pedido, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSImportaClientesSemDadosPedidoAvancado






















101





















102




103

63. Importação de Cliente por ID de Cliente (modo avançado)

Disponibilização dos dados de cliente conforme o ID do cliente, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSImportaClientePorIdAvancado






















104


















105





106

64. Importação de Cliente por CPF de Cliente (modo avançado)

Disponibilização dos dados de cliente conforme o CPF do cliente, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSImportaClientePorCPFAvancado






cpf string 15 Sim CPF do cliente - pode conter pontuação















107



















108





109

65. Importação de Cliente por E-mail de Cliente (modo avançado)

Disponibilização dos dados de cliente conforme o e-mail do cliente, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSImportaClientePorEmailAvancado






email string 250 Sim E-mail do cliente















110



















111





112

66. Importação de Cliente por CNPJ de Cliente (modo avançado)

Disponibilização dos dados de cliente conforme o CNPJ do cliente, incluindo os campos de desconto de revenda, endereço de cobrança e endereço de entrega.

Método: fWSImportaClientePorCNPJ






cnpj string 18 Sim CNPJ do cliente - pode conter pontuação















113



















114





115

67. Formas de Pagamento Disponíveis

Obtém o código e nome das formas de pagamento disponíveis na loja.

Método: fWSFormasPagamentosDisponiveis






Id_perfil_cliente Integer 11 Não Se não informado, é retornado baseado no perfil Padrão (1)




array

- id_forma_pagamento string 10 Sim ID da forma de pagamento na loja

- nome_forma_pagamento string 100 Sim Nome da forma de pagamento na loja


116

68. Relacionamento de Descontos/Acréscimos Específicos por Produtos

Obtém o código e nome das formas de pagamento disponíveis na loja.

Método: fWSRelacionaDescontoAcrescimoProduto






Id_produto string 11 Sim ID do produto

Id_forma_pagamento string 10 Sim ID da forma de pagamento (retorno do método fWSFormasPagamentosDisponiveis)

tipo_venda_normal Integer 1 Não 0: Acréscimo / 1: Desconto

valor_venda_normal float 11,2 Não Valor do acréscimo ou desconto para vendas normais

tipo_venda_intermediada Integer 1 Não 0: Acréscimo / 1: Desconto

valor_venda_intermediada float 11,2 Não Valor do acréscimo ou desconto para vendas intermediadas

parcela_maxima_desconto_normal Integer 3 Não Parcela máxima para aplicação de descontos para vendas normais

parcela_maxima_desconto_intermediada integer 3 Não Parcela máxima para aplicação de descontos para vendas intermediadas




Se não informado nenhum valor em “parcela_maxima_desconto_normal“ e “parcela_maxima_desconto_intermediada” será considerado o valor máximo de parcelamento aceito pela forma.


117

69. Cadastro/atualização de notas fiscais de pedidos

Responsável pelo cadastro/atualização de notas fiscais nos pedidos. É permitida a inclusão de uma nota fiscal por pedido apenas.

Método: fWSCadastraNotaFiscalPedido






id_pedido integer 11 Sim ID do pedido que deseja realizar o atrelamento ou alteração de nota

dados_nota_fiscal Array 11 Sim Detalhes relacionados a nota fiscal




id_nota_fiscal integer 11 Sim ID do relacionamento entre pedido e nota fiscal


$dados_nota_fiscal[item][0]['campo'] = ""; $dados_nota_fiscal[item][0]['valor'] = "";

A var 'campo' poderá ser exatamente (marcados com * são obrigatórios):

- id_nota_fiscal (se editando, torna-se obrigatório) - data_emissao* - numero_nota* - serie_nota* - valor_nota* - chave_nota* - link_nota - xml_danfe


118

70. Consulta de notas fiscais de pedidos

Responsável consulta de notas fiscais nos pedidos.

Método: fWSImportaNotaFiscalPedido






id_pedido integer 11 Sim ID do pedido que deseja realizar o atrelamento ou alteração de nota



id integer 11 Sim ID entre pedido e nota fiscal (em fWSCadastraNotaFiscalPedido chama-se “id_nota_fiscal”)

data_emissao string 10 Sim Data da emissão da nota - ex: "2009-11-16"

numero_nota string 80 Sim Número da nota

serie_nota string 10 Sim Série da nota

valor_nota string 15,2 Sim Valor total da nota - formato: "0.00"

chave_nota string 80 Sim Chave da nota

link_nota string 80 Não Link para acesso à nota

xml_danfe string - Não Conteúdo do XML da nota

Manual de Integração -...

Documents

Transcript of Manual de Integração -...