Manual de Integração
WebService Tray
Versão 3.9.1
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
31. Remoção de Registro para não Sincronismo com o WebService ................................................................ 47
32. Consulta de Status de Pedido ...................................................................................................................... 48
33. Compre Junto e Brinde ................................................................................................................................ 49
34. Produtos Relacionados ................................................................................................................................ 51
35. Cadastro de Lista de Desejo......................................................................................................................... 52
36. Cadastro de Produtos de Lista de Desejo .................................................................................................... 54
37. Exclui Lista de Desejos ................................................................................................................................. 55
38. Exclui Produto da Lista de Desejo ................................................................................................................ 56
39. Pesquisa de Vendas da Lista de Desejo do Cliente ...................................................................................... 57
40. Busca Lista de Desejo................................................................................................................................... 58
41. Importação de Produto por Código de Referência...................................................................................... 60
42. Importação de Itens de Pedido por ID de Pedido........................................................................................ 62
43. Importação de Parcelas de Pedido por ID de Pedido .................................................................................. 64
44. Importação de Cliente por ID de Cliente ..................................................................................................... 66
45. Importação de Cliente por E-mail de Cliente............................................................................................... 68
46. Importação de Cliente por CPF de Cliente................................................................................................... 70
47. Importação de Cliente por CNPJ de Cliente................................................................................................. 72
48. Importação de Cliente sem Dados de Pedido ............................................................................................. 74
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
49.
50.
51.
52.
53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
Relacionamento de Cliente com Perfil de Cliente ....................................................................................... 76
Lista de Preço de Cliente ............................................................................................................................. 77
Cadastro de Campos para Grupo de Imposto ............................................................................................. 78
Cadastro de Grupo de Imposto ................................................................................................................... 79
Relacionamento de Grupo de Imposto com Categorias ou Produtos ......................................................... 81
Atualização de Dados de Recursos Extras ................................................................................................... 83
Compre Junto Avançado .............................................................................................................................. 84
Converte Pedido em Comissão .................................................................................................................... 86
Importação de Variação por Código de Referência ..................................................................................... 87
Importação de Categoria por Nome ............................................................................................................ 88
Cliente (modo avançado)............................................................................................................................. 89
Importação de Cliente (modo avançado) .................................................................................................... 92
Importação de Cliente com Pedido (modo avançado) ................................................................................ 95
Importação de Cliente sem Dados de Pedido (modo avançado) ................................................................ 98
Importação de Cliente por ID de Cliente (modo avançado) ...................................................................... 101
Importação de Cliente por CPF de Cliente (modo avançado) ................................................................... 104
Importação de Cliente por E-mail de Cliente (modo avançado) ............................................................... 107
Importação de Cliente por CNPJ de Cliente (modo avançado) ................................................................. 110
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
1
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
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_categoria
integer
11
Sim
ID da categoria cadastrada ou alterada
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
2
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
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 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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
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’:
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
3
$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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
4
3. Marca de Produto
Trata-se das marcas dos produtos que serão disponibilizados na loja.
Método: fWSCadastraMarca
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_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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_marca
integer
11
Sim
ID da marca cadastrada ou alterada
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
5
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
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
id_caracteristica
integer
11
Sim
Senha do login válido na ADM da loja
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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_caracteristica
integer
11
Sim
ID da característica cadastrada ou alterada
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
6
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
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_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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_perfil
integer
11
Sim
ID do perfil cadastrado ou alterado
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
7
6. Relacionamento de Característica com Perfil de Produto
Responsável pelo relacionamento de características no perfil.
Método: fWSRelacionaCaractPerfil
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_perfil
integer
11
Sim
ID do perfil de produto
id_caracteristica
integer
11
Sim
ID da característica de produto
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
chaves
string
50
Sim
Retorno dos ID´s de perfil e característica separados por 'pipe' - ex: "123|456"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
8
7. Relacionamento de Categoria com Perfil de Produto
Responsável pelo relacionamento do Perfil com a Categoria.
Método: fWSRelacionaCategPerfil
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_perfil
integer
11
Sim
ID do perfil de produto
id_categoria
integer
11
Sim
ID da categoria de produto
Campos
Tipo
Parâmetros de Saída
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
chaves
string
50
Sim
Retorno dos ID´s de perfil e categoria separados por 'pipe' - ex: "123|456"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
9
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
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_produto
integer
11
Sim
ID do produto
id_caracteristica
integer
11
Sim
ID da característica de produto
valor
string
100
Sim
Valor da característica de produto
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
chaves
string
50
Sim
Retorno dos ID´s de caracteristica e produto separados por 'pipe' - ex: "123|456"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
10
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
11
9. Produto
Responsável pelo cadastro/atualização dos produtos.
Método: fWSCadastraProduto
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
id_produto
integer
11
Sim
Senha do login válido na ADM da loja
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"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
12
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_produto
integer
11
Sim
ID do produto cadastrado ou alterado
Exemplo de array do campo ‘informacao’:
A var 'TipoNome' poderá ser exatamente:
$informacao[0]['TipoNome'] = "";
$informacao[0]['Texto'] = "";
$informacao[1]['TipoNome'] = "";
$informacao[1]['Texto'] = "";
$informacao[N]['TipoNome'] = "";
$informacao[N]['Texto'] = "";
- 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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
13
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
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
id_produto
integer
11
Sim
Senha do login válido na ADM da loja
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
14
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_produto
integer
11
Sim
ID do produto cadastrado ou alterado
Exemplo de array do campo ‘informacao’:
A var 'TipoNome' poderá ser exatamente:
$informacao[0]['TipoNome'] = "";
$informacao[0]['Texto'] = "";
$informacao[1]['TipoNome'] = "";
$informacao[1]['Texto'] = "";
$informacao[N]['TipoNome'] = "";
$informacao[N]['Texto'] = "";
- ITENS INCLUSOS
- VIDEO
- GARANTIA
- DISPONIBILIDADE
- DESCRICAO CURTA
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
15
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
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_grade
integer
11
Sim
ID da variação - "0" para incluir e ID para alterar
id_produto
integer
11
Sim
ID do produto
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
16
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_grade
integer
11
Sim
ID da variação cadastrada ou alterada
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
17
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
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_grade
integer
11
Sim
ID da variação
id_caracteristica
integer
11
Sim
ID da característica de produto
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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
chaves
string
50
Sim
Retorno dos ID´s de variação e caracteristica separados por 'pipe' - ex: "123|456"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
18
13. Promoção de Produto
Responsável pelo cadastro de promoções específicas da loja.
Método: fWSCadastraPromocao
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_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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_promocao
integer
11
Sim
ID da promoção cadastrada ou alterada
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
19
14. Relacionamento de Promoção com Produto
Responsável pelo atrelamento de produto a uma promoção específica da loja.
Método: fWSRelacionaPromoProduto
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_produto
integer
11
Sim
ID do produto
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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
chaves
string
50
Sim
Retorno dos ID´s de promoção e produto por 'pipe' - ex: "123|456"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
20
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
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
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'
preco
string
15,2
Sim
Preço do produto em Real - formato: "0.00"
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"
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
21
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
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_produto
integer
11
Sim
ID do produto
disponivel
integer
1
Sim
Flag de disponibilidade - pode ser: “0” para não disponível ou “1” para disponível
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_produto
integer
11
Sim
ID do produto alterado
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
22
17. Atualização de Estoque de Produto
Responsável pela atualização do estoque dos produtos.
Método: fWSAtualizaEstoqueProduto
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
status
string
id_produto
integer 11
2
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
Sim
ID do produto alterado
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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
23
18. Cliente
Responsável pelo cadastro de novos clientes na loja.
Método: fWSCadastraCliente
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_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"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
24
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
25
19. Cadastra Contato de Cliente
Responsável pelo cadastro de contato de cliente na loja.
Método: fWSCadastraContatosCliente
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_cliente
integer
11
Sim
ID do cliente - "0" para incluir e ID para alterar
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
Parâmetros de Saída
Campos
status
Tipo
string
Tamanho
2
Obrigatório
Sim
Descrição
Status da operação - pode ser: "ok" ou "no"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
26
20. Cadastra Endereço de Cliente
Responsável pelo cadastro de endereço de cliente na loja.
Método: fWSCadastraEnderecoCliente
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_cliente
integer
11
Sim
ID do cliente - "0" para incluir e ID para alterar
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
Parâmetros de Saída
Campos
status
Tipo
string
Tamanho
2
Obrigatório
Sim
Descrição
Status da operação - pode ser: "ok" ou "no"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
27
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
28
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
29
22. Importação de Pedido por ID
Disponibilização de todos os dados de um pedido específico.
Método: fWSImportaPedidoPorId
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_pedido
integer
11
Sim
ID do pedido para captura de dados
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
30
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
31
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
ID do pedido
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
32
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
33
24. Importação de Cliente com Pedido
Disponibilização de todos os clientes que possuem pedidos na loja virtual.
Método: fWSImportaClientesComPedido
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
ID do pedido
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
34
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
35
25. Importação de Cliente sem Pedido
Disponibilização de todos os clientes que não possuem pedidos na loja virtual.
Método: fWSImportaClientesSemDadosPedido
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
ID do pedido
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
36
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
37
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
Código do pedido
id_produto
integer
11
Sim
ID do produto
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
38
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
status
string
100
Não
Status do pedido
brinde
integer
1
Não
Identificação se o produto é um brinde. Formato: “0” para não, “1” para sim
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
39
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
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_pedido
integer
11
Sim
ID do pedido para captura de itens do pedido
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
Código do pedido
id_produto
integer
11
Sim
ID do produto
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
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
status
string
100
Não
Status do pedido
id_lista
integer
11
Não
ID Lista de Desejos
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
40
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
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
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
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
status_atual
string
100
Não
Status de pedidos - vazio para todos os status
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_parcela
integer
11
Sim
ID da parcela (ID do pedido concatenado com o contador da parcela)
id_pedido
integer
11
Sim
Código do pedido
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
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
valor_pago
string
15,2
Não
Valor pago do pedido em Real - formato: "0.00"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
41
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
status
string
100
Não
Status do pedido
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
42
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
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_pedido
integer
11
Sim
ID do pedido para captura de parcelamentos
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_parcela
integer
11
Sim
ID da parcela (ID do pedido concatenado com o contador da parcela)
id_pedido
integer
11
Sim
Código do pedido
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
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
valor_pago
string
15,2
Não
Valor pago do pedido em Real - formato: "0.00"
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
string
4
Sim
Número de parcelas do pedido
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
43
status
string
100
Não
Status do pedido
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
44
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
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
lista_status
array
-
Sim
Variável tipo 'array' com dados obrigatórios para alteração do status de pedido
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_pedido
integer
11
Sim
Código do pedido alterado
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
45
Exemplos de array do campo ‘lista_status’:
$lista_status['protocolo']
$lista_status['pedido']
$lista_status['id_status']
$lista_status['status']
$lista_status['Data']
$lista_status['Hora']
$lista_status['SerieNota']
$lista_status['NumeroNota']
$lista_status['DataEmissaoNota']
$lista_status['HoraEmissaoNota']
$lista_status['NumeroObjeto']
$lista_status['QtVolumes']
=
=
=
=
=
=
=
=
=
=
=
=
"";
2;
59;
"";
"";
"";
"";
"";
"";
"";
"";
"";
$lista_status[0]['protocolo']
=
$lista_status[0]['pedido']
=
$lista_status[0]['id_status']
=
$lista_status[0]['status']
=
$lista_status[0]['Data']
=
$lista_status[0]['Hora']
=
$lista_status[0]['SerieNota']
=
$lista_status[0]['NumeroNota']
=
$lista_status[0]['DataEmissaoNota'] =
$lista_status[0]['HoraEmissaoNota'] =
$lista_status[0]['NumeroObjeto']
=
$lista_status[0]['QtVolumes']
=
"";
2;
59;
"";
"";
"";
"";
"";
"";
"";
"";
"";
ou
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
46
31. 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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id
integer
11
Sim
ID do registro no banco de dados
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
47
32. Consulta de Status de Pedido
Método que retorna o Status atual do pedido.
Método: fWSConsultaStatusPedido
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_pedido
integer 11
Sim
ID do pedido para consulta de Status
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
48
33. 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
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_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
-
Parâmetros de Saída
Campos
status
Tipo
string
Tamanho
2
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
id_compre_junto integer 11
Não
ID do Compre Junto adicionado ou atualizado
id_produto
Sim
ID do produto principal
integer 11
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
49
Exemplo de array do campo ‘compre_junto’:
$compre_junto[0]['produto']
$compre_junto[0]['tipo_desconto']
$compre_junto[0]['desconto']
= (ID do produto pertencente ao Compre Junto);
= (0 para R$ / 1 para %);
= (Valor do desconto para o Compre Junto).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
50
34. Produtos Relacionados
Método para cadastro e manutenção de itens dos Produtos Relacionados.
Método: fWSRelacionaProduto
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_produto
integer 11
Sim
ID do produto principal
produtos_relacionados
array
Sim
Array de produtos relacionados. Até 4 posições.
-
Parâmetros de Saída
Campos
Tipo
Tamanho
status
string
id_produto
integer 11
id_produtos_relacionados string
2
-
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
Sim
ID do produto principal
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
51
35. Cadastro de Lista de Desejo
Método para cadastro e alteração de lista de desejo.
Método: fWSCadastraListaDesejos
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
valoresLista
array
-
Sim
Array parâmetros a serem inseridos ou atualizados na lista.
Parâmetros de Saída
Campos
Tipo
Tamanho
status
string
2
id_lista
integer 11
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
Sim
ID lista
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
52
Exemplo de array do campo ‘valoresLista’:
$valoresLista[‘id’]
$valoresLista[‘id_cliente’]
$valoresLista[‘id_eventos’]
$valoresLista[‘cliente_enderecos’]
$valoresLista[‘data’]
$valoresLista[‘data_cadastro’]
$valoresLista[‘nome’]
$valoresLista[‘staus’]
$valoresLista[‘data_fanalizado’]
$valoresLista[‘cartao’]
$valoresLista[‘url’]
$valoresLista[‘recebimento’]
$valoresLista[‘envia _email’]
$valoresLista[‘mensagem’]
=
=
=
=
=
=
=
=
=
=
=
=
=
=
ID Lista em caso de alteração
ID Cliente
ID eventos.
ID endereço do Cliente
Data do Evento
Data do Cadastro
Nome da Lista
1 – Ativa ou 0 - Inativa
Término prazo lista
1 – Recebe ou 0 – Não recebe
url de acesso da lista
0 – Vpv 0u 1 – após o fechamento
0 – Não ou 1 – Sim
Mensagem a ser exibida na lista
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
53
36. Cadastro de Produtos de Lista de Desejo
Método para cadastro e alteração de produtos em determinada lista de desejo.
Método: fWSCadastraListaProdutos
Parâmetros de Entrada
Campos
Tipo
Tamanho
Obrigatório
Descrição
pid_loja
integer 11
Sim
ID da loja
plogin
string
Sim
Login de usuário válido na ADM da loja
80
psenha
string
80
Sim
Senha do login válido na ADM da loja
dados_lista
array
-
Sim
Array parâmetros a serem inseridos ou atualizados na lista.
Parâmetros de Saída
Campos
Tipo
Tamanho
status
string
id
integer 11
Obrigatório
2
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
Sim
ID lista
Exemplo de array do campo ‘dados_lista’:
$produtoLista['id']
$produtoLista['id_lista']
$produtoLista['id_produto']
$produtoLista['quantidade']
$produtoLista['id_grade']
$produtoLista['quantidade_comprada']
=
=
=
=
=
=
Necessário passar o ID em caso de alteração;
ID Lista;
ID Produto;
Quantidade;
ID da grade da variação;
Quantidade já adquirida.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
54
37. Exclui Lista de Desejos
Método para exclusão de lista de desejos.
Método: fWSExcluiListaDesejos
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_lista
integer 11
Sim
ID da lista a ser excluída
Parâmetros de Saída
Campos
Tipo
Tamanho
status
string
2
id
integer 11
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
Sim
ID lista
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
55
38. Exclui Produto da Lista de Desejo
Método para exclusão de produtos de lista de desejo.
Método: fWSExcluirProdutoLista
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
idProdLista
integer 11
Sim
ID do produto
Parâmetros de Saída
Campos
status
Tipo
string
Tamanho
2
Obrigatório
Sim
Descrição
Status da operação - pode ser: "ok" ou "no"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
56
39. 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
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_lista
integer 11
Não
ID lista
id_cliente
integer 11
Não
ID cliente
Parâmetros de Saída
Campos
resultado
Tipo
array
Tamanho
-
Obrigatório
Sim
Descrição
Array da consulta
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
57
40. Busca Lista de Desejo
Método de busca de lista de desejo.
Método: fWSBuscaListas
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
idLista
integer 11
Não
ID lista
Parâmetros de Saída
Campos
id_lista
Tipo
Tamanho
integer 11
Obrigatório
Sim
Descrição
ID da Lista
quantidade
integer 11
Sim
Quantidade solicitada
quantidade_comprada
integer 11
Sim
Quantidade Adquirida
nome_produto
string
80
Sim
Nome do Produto
id_produto
integer 11
Sim
ID do produto
variacao
integer 11
Não
ID da variação do Produto se possuir
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
58
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
)
)
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
59
41. 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
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
cod_referencia
string
11
Sim
Código de referência de produto
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_produto
integer
11
Sim
ID do produto
id_marca
integer
11
Sim
ID da marca 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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
60
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"
estoque
string
11
Sim
Quantidade de estoque do produto
estoque_minimo
string
11
Não
Quantidade mínima de estoque do produto
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
Exemplo de array do campo ‘informacao’:
A var 'TipoNome' poderá ser exatamente:
$informacao[0]['TipoNome'] = "";
$informacao[0]['Texto'] = "";
$informacao[1]['TipoNome'] = "";
$informacao[1]['Texto'] = "";
$informacao[N]['TipoNome'] = "";
$informacao[N]['Texto'] = "";
- ITENS INCLUSOS
- VIDEO
- GARANTIA
- DISPONIBILIDADE
- DESCRICAO CURTA
- TIPO PRODUTO (opções: “VIRTUAL” ou “FISICO”. Se não informado = “FISICO”)
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
61
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
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_pedido
integer
11
Sim
ID do pedido
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
Código do pedido
id_produto
integer
11
Sim
ID do produto
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
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
status
string
100
Não
Status do pedido
id_lista
integer
11
Não
ID Lista de Desejos
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
62
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
63
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
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_pedido
integer
11
Sim
ID do pedido
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_parcela
integer
11
Sim
ID da parcela (ID do pedido concatenado com o contador da parcela)
id_pedido
integer
11
Sim
Código do pedido
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
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
valor_pago
string
15,2
Não
Valor pago do pedido em Real - formato: "0.00"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
64
qt_parcelas
string
4
Sim
Número de parcelas do pedido
status
string
100
Não
Status do pedido
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
65
44. Importação de Cliente por ID de Cliente
Disponibilização dos dados de cliente conforme o ID do cliente.
Método: fWSImportaClientePorId
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_cliente
integer
11
Sim
ID do cliente
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
66
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
67
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
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
email
string
250
Sim
E-mail do cliente
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
68
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
69
46. Importação de Cliente por CPF de Cliente
Disponibilização dos dados de cliente conforme o CPF do cliente.
Método: fWSImportaClientePorCPF
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
cpf
string
15
Sim
CPF do cliente - pode conter pontuação
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
70
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
71
47. Importação de Cliente por CNPJ de Cliente
Disponibilização dos dados de cliente conforme o CNPJ do cliente.
Método: fWSImportaClientePorCNPJ
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
cnpj
string
18
Sim
CNPJ do cliente - pode conter pontuação
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
72
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
73
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
74
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
75
49. Relacionamento de Cliente com Perfil de Cliente
Método que faz o relacionamento de cliente ao perfil de cliente.
Método: fWSRelacionaClientePerfil
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_cliente
integer
11
Sim
ID do cliente
id_perfil
integer
11
Sim
ID do perfil de cliente
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
100
Sim
Status da operação - pode ser: "ok" ou "no"
id_cliente
integer
11
Sim
ID do cliente
id_perfil
integer
11
Sim
ID do perfil de cliente
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
76
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
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_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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
100
Sim
Status da operação - pode ser: "ok" ou "no"
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_produtos_precos[0]['variacao']
$id_produtos_precos[0]['valor']
$id_produtos_precos[1]['id']
$id_produtos_precos[1]['variacao']
$id_produtos_precos[1]['valor']
= ID de produto ou ID da variação de produto
= Caso for “0”: $id_produtos_precos[0]['id'] é ID de produto; caso for “1”: $id_produtos_precos[0]['id'] é ID de variação
= Valor do produto ou variação
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
77
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
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_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
valor_cliente_loja integer
1
Não
Tipo do campo de imposto - “1” para produto e “2” para cliente
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_campo
integer
-
Sim
ID do campo de imposto
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
78
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
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_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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_grupo
integer
11
Sim
ID do grupo de imposto
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
79
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
80
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
grupo_id
integer
11
Sim
Id do grupo relacionado
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
81
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'] = "";
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
82
54. Atualização de Dados de Recursos Extras
Parametriza valores dinamicamente de recursos extras.
Método: fWSDadosRecursosExtras
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_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 “grades”
campo
string
30
Sim
Nome do campo do alvo para alteração - pode ser: "dimensao:largura", "dimensao:altura" ou "dimensao:comprimento"
valor
string
255
Sim
Valor do campo para alteração
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
id_registro
integer
11
Não
ID do registro alterado
entidade
string
30
Não
Nome do alvo alterado
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
83
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
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_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"
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
-
Parâmetros de Saída
Campos
status
Tipo
string
Tamanho
2
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
id_compre_junto integer 11
Não
ID do Compre Junto adicionado ou atualizado
id_produto
Sim
ID do produto principal
integer 11
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
84
Exemplo de array do campo ‘compre_junto’:
$compre_junto[0]['produto']
$compre_junto[0]['tipo_desconto']
$compre_junto[0]['desconto']
= (ID do produto pertencente ao Compre Junto);
= (0 para R$ / 1 para %);
= (Valor do desconto para o Compre Junto).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
85
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
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_pedido
integer 11
Sim
ID do pedido para converter em crédito
Parâmetros de Saída
Campos
Tipo
Tamanho
status
string
2
id_pedido
integer 11
Obrigatório
Descrição
Sim
Status da operação - pode ser: "ok" ou "no"
Sim
ID do pedido
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
86
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
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
cod_referencia
string
80
Sim
Código de referência da variação
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_grade
integer 11
Sim
ID da variação do produto
id_produto
integer 11
Sim
ID do produto
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
87
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
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_categoriapai
integer 11
Sim
ID da categoria principal
descricao
string
Não
Nome da categoria principal
255
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_categoria
integer 11
Sim
ID da categoria relacionada
id_categoriapai
integer 11
Sim
ID da categoria principal
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
88
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
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_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"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
89
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
desconto_revenda
string
15,2
Não
enderecos
array
-
Sim
Valor de desconto para o cliente revendedor
Dados de endereços: Obrigatório: dados de endereço de entrega / Opcional: dados de endereço de
cobrança
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
status
string
2
Sim
Status da operação - pode ser: "ok" ou "no"
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.
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
90
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
91
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
ID do pedido
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
92
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
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"
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
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
dados_extras
array
-
Não
Dados adicionais de clientes
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
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).
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
94
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_pedido
integer
11
Sim
ID do pedido
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
95
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
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"
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
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
dados_extras
array
-
Não
Dados adicionais de clientes
Exemplo de array do campo ‘enderecos’:
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
97
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
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
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
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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"
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
98
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
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
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
dados_extras
array
-
Não
Dados adicionais de clientes
Exemplo de array do campo ‘enderecos’:
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
99
$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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
100
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
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_cliente
integer
11
Sim
ID do cliente
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
observacao
string
-
Sim
Breve observação referente ao cliente
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
101
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
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
dados_extras
array
-
Não
Dados adicionais de clientes
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
102
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).
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
103
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
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
cpf
string
15
Sim
CPF do cliente - pode conter pontuação
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
104
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
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
dados_extras
array
-
Não
Dados adicionais de clientes
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
105
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).
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
106
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
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
email
string
250
Sim
E-mail do cliente
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
107
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
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
dados_extras
array
-
Não
Dados adicionais de clientes
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
108
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).
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
109
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
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
cnpj
string
18
Sim
CNPJ do cliente - pode conter pontuação
Parâmetros de Saída
Campos
Tipo
Tamanho
Obrigatório
Descrição
id_cliente
integer
11
Sim
ID do cliente
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
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"
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
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
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
110
observacao
string
-
Sim
Breve observação referente ao cliente
logradouro
string
200
Sim
Endereço do cliente
numero
string
10
Sim
Número do endereço do cliente
bairro
string
100
Sim
Bairro do endereço do cliente
complemento
string
60
Sim
Complemento do endereço do cliente
cep
string
8
Sim
CEP do endereço - somente números - ex: "17500140"
cidade
string
200
Sim
Cidade do cliente
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
status
string
100
Não
Status do pedido
id_perfil
integer
11
Não
ID do perfil de cliente
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
dados_extras
array
-
Não
Dados adicionais de clientes
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
111
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).
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).
Rua Alcides Lajes Magalhães, 130 - Jardim Acapulco - CEP: 17525-181 - Marília SP
Fone: (14) 3311-8700 | www.tray.com.br
112