-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Este método retorna a lista de Estoques de Cliente e Centros de distribuição cadastrados no provedor.
Sintaxe
public string GetDealerStocks(string properties)
Montagem das propriedades
O conteúdo de string properties deve ser um texto em formato JSON contendo as propriedades abaixo. Por exemplo:
{"DealerName":"dealer","DealerUserEmail":"user@example.com","DealerUserPassword":"k1BAv1w=="}
Não é necessário se preocupar com nomes de propriedades maiúsculos ou minúsculos, o Web Service é Case-Insensitive.
Propriedades aceitas pelo método
|
Propriedade |
Tipo |
Obrigatório |
Permite nulo |
Permite vazio |
Tamanho máximo |
Descrição |
|
DealerName |
Texto |
Sim |
- |
- |
- |
Nome do provedor |
|
DealerUserEmail |
Texto |
Sim |
- |
- |
- |
E-mail do usuário do provedor |
|
DealerUserPassword |
Texto |
Sim |
- |
- |
- |
Senha do usuário criptografada |
|
StockTypeID |
Número |
Não |
- |
- |
- |
Tipo do estoque que deseja buscar (1 - Centro de distribuição, 2 - Estoque do cliente). Só precisa ser informado se desejar filtrar pelo tipo do estoque |
|
StockName |
Texto |
Não |
- |
- |
- |
Nome do estoque. Só precisa ser informado se desejar filtrar pelo nome do estoque |
|
FieldsList |
Texto |
Não |
Sim |
Sim |
- |
Lista dos campos que serão retornados pelo método. Devem ser especificados separando-os pelo caractere ‘;’. Exemplo: PrinterDeviceID;SiteID;SiteName. Quando nenhum campo for especificado a resposta conterá os campos que estão em negrito na tabela abaixo |
Campos de retorno reconhecidos em FieldsList
|
Nome do campo |
Descrição |
|
StockID |
Identificador do estoque no sistema |
|
StockName |
Nome do estoque |
|
StockTypeID |
Identificador do tipo do estoque (1 - Centro de distribuição, 2 - Estoque do cliente) |
|
Description |
Descrição do estoque |
|
ContactName |
Nome do contato cadastrado no estoque |
|
ContactEmail |
E-mail do contato cadastrado no estoque |
|
ContactPhone |
Telefone do contato cadastrado no estoque |
|
EnterpriseName |
Nome da empresa atendia pelo estoque. Será apresentado vazio quando um Estoque de cliente não atende ninguém ou quando se trata de um Centro de Ditribuição |
|
AddressCountry |
País onde o estoque está localizado |
|
AddressState |
Estado onde o estoque está localizado |
|
AddressCity |
Cidade onde o estoque está localizado |
|
AddressStreet |
Rua onde se encontra o estoque |
|
AddressNeighborhood |
Bairro onde se encontra o estoque |
|
AddressPostalCode |
CEP onde se encontra o estoque |
|
AddressNumber |
Número de localização do estoque |
|
AddressAdditionalInfo |
Complemento do endereço do estoque |
|
ProgDays |
Período em dias que a próxima programação deve ser realizada |
|
SecurityOnly |
Indica se a programação do estoque é somente para itens de segurança |
|
CustomField1InUse |
Indica se o primeiro campo adicional está em uso (False - Não utilizado, True - Em uso) |
|
CustomField1Name |
Nome do primeiro campo adiconal |
|
CustomField1Value |
Valor do primeiro campo adicional |
|
CustomField2InUse |
Indica se o segundo campo adicional está em uso (False - Não utilizado, True - Em uso) |
|
CustomField2Name |
Nome do segundo campo adicional |
|
CustomField2Value |
Valor do segundo campo adicional |
|
CustomField3InUse |
Indica se o terceiro campo adicional está em uso (False - Não utilizado, True - Em uso) |
|
CustomField3Name |
Nome do terceiro campo adicional |
|
CustomField3Value |
Valor do terceiro campo adicional |
Retorno
Clique aqui para saber mais sobre o formato dos retornos.
Possíveis erros retornados
Clique aqui para verificar os possíveis erros que podem ser retornados e conhecer seus motivos.
Restrições
-
Para executar este método o usuário informado precisa ter permissão completa em Administração de Estoque.