-
Web Service URL: https://[SERVER_ADDRESS]/GeneralWS/GeneralData2.asmx
-
MPS Versão: A partir da 5.5.0
Descrição
Este método cadastra um novo Estoque de Cliente no provedor. Caso o Estoque de Cliente já exista, este método pode ser utilizado para atualizar informações de endereço.
Sintaxe
public string ImportCompanyStocks(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 |
|
StockName |
Texto |
Sim |
- |
- |
255 |
Nome do estoque que será ser cadastrado |
|
Description |
Texto |
Sim |
- |
- |
255 |
Descrição do estoque que será cadastrado |
|
ProgDays |
Número |
Sim |
- |
- |
- |
Período em dias que a próxima programação deve ser realizada. Permite valores a partir de 7 até 999 |
|
SecurityOnly |
Lógico |
Sim |
- |
- |
- |
Indica se a programação do estoque é somente para itens de segurança |
|
CountryName |
Texto |
Sim |
- |
- |
100 |
País onde o estoque a ser cadastrado se encontra |
|
StateName |
Texto |
Sim |
- |
- |
100 |
Estado onde o estoque a ser cadastrado se encontra |
|
CityName |
Texto |
Sim |
- |
- |
100 |
Cidade onde o estoque a ser cadastrado se encontra |
|
Street |
Texto |
Sim |
- |
- |
255 |
Nome da rua onde o estoque a ser cadastrado se encontra |
|
Neighborhood |
Texto |
Sim |
- |
- |
100 |
Nome do bairro onde o estoque a ser cadastrado se encontra |
|
PostalCode |
Texto |
Sim |
- |
- |
20 |
Número do código postal onde o estoque a ser cadastrado se encontra |
|
Number |
Número |
Não |
Sim |
- |
- |
Número do local onde o estoque se encontra |
|
AdditionalInfo |
Texto |
Não |
Sim |
Sim |
255 |
Informações adicionais de onde o estoque se encontra |
|
ContactName |
Texto |
Não |
- |
- |
- |
Nome do contato do estoque |
|
ContactEmail |
Texto |
Não |
- |
- |
- |
E-mail do contato do estoque |
|
ContactPhone |
Texto |
Não |
- |
- |
- |
Telefone do contato do estoque |
|
CustomField1InUse |
Lógico |
Não |
- |
- |
- |
Indica se o primeiro campo adicional será usado no estoque (false - Para não utilizar; true - Para utilizar) |
|
CustomField1Name |
Texto |
Não |
- |
- |
- |
Nome do primeiro campo adicional |
|
CustomField1Value |
Texto |
Não |
- |
- |
- |
Valor do primeiro campo adicional |
|
CustomField2InUse |
Lógico |
Não |
- |
- |
- |
Indica se o segundo campo adicional será usado no estoque (false - Para não utilizar; true - Para utilizar) |
|
CustomField2Name |
Texto |
Não |
- |
- |
- |
Nome do segundo campo adicional |
|
CustomField2Value |
Texto |
Não |
- |
- |
- |
Valor do segundo campo adicional |
|
CustomField3InUse |
Lógico |
Não |
- |
- |
- |
Indica se o terceiro campo adicional será usado no estoque (false - Para não utilizar; true - Para utilizar) |
|
CustomField3Name |
Texto |
Não |
- |
- |
- |
Nome do terceiro campo adicional |
|
CustomField3Value |
Texto |
Não |
- |
- |
- |
Valor do terceiro campo adicional |
Caracteres não permitidos nos parâmetros e o erro que será retornado
|
Parâmetro |
Caracteres não permitidos |
Erro |
|
stockName |
; |
ERR_DATA_INVALIDSTOCKNAME |
|
description |
; |
ERR_DATA_INVALIDSTOCKDESCRIPTION |
|
countryName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDCOUNTRYNAME |
|
stateName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDSTATENAME |
|
cityName |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDCITYNAME |
|
street |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDSTREET |
|
neighborhood |
!@#$%¨&*=§[]{}ºª?/°;:><\/+-.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDNEIGHBORHOOD |
|
postalCode |
!@#$%¨&*=§[]{}ºª?/°;:><\/+.,_()³£¢¬²+|´`´~^+\ |
ERR_DATA_INVALIDPOSTALCODE |
Retorno
Se obtiver sucesso, o retorno é: [{"StockID":number}], onde number é o número identificador no novo estoque inserido.
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.