VTEX Webservice Guide  
 
Conheça as Classes e Métodos disponíveis em SOAP

   
 
Índice 
Classes 6
BrandDTO 6
BuyTogetherBuyGainDTO 6
BuyTogetherDTO 6
BuyTogetherTakeXPayYDTO 7
CategoryDTO 7
GiftCardDTO 8
GiftCardTransactionItemDTO 8
GiftListDTO 8
GiftListMemberDTO 9
GiftListStockKeepingUnitDTO 9
GiftListTypeDTO 10
ImageDTO 10
ProductDTO 11
ProductFieldIdDTO 12
ProductFieldNameDTO 12
ServiceDTO 12
ServicePriceDTO 13
StockKeepingUnitComplementDTO 13
StockKeepingUnitDTO 13
StockKeepingUnitEanDTO 15
StockKeepingUnitFieldIdDTO 15
StockKeepingUnitFieldNameDTO 15
StockKeepingUnitQuantityDTO 15
StockKeepingUnitServiceDTO 16

Methods 17
BrandGet 17
BrandGetByName 17
BrandInsertUpdate 17
BuyTogetherBuyGainInsertUpdate 18
BuyTogetherDeleteById 18
BuyTogetherInsertUpdate 18
BuyTogetherSkuListInsertUpdate 19
CategoryGet 19
CategoryGetByName 19
CategoryInsertUpdate 19
CollectionGet 20
GiftCardGet 20
GiftCardGetByRedeptionCode 20
GiftCardInsertUpdate 21
GiftCardTransactionItemInsert 21
GiftCardTransactionItemSetStatus 21
GiftListGet 22
GiftListGetAllBetweenEventDateIntervalAndId 22
GiftListGetAllFromCreatedDateAndId 22
GiftListGetAllFromModifiedDateAndId 23
GiftListGetByClient 23
GiftListGetByCreatedDate 23
GiftListGetByGifted 24
GiftListGetByModifiedDate 24
GiftListGetType 24
GiftListInsertUpdate 24
GiftListMemberDelete 25
GiftListMemberInsertUpdate 25
GiftListSearch 26
GiftListSkuDelete 26
GiftListSkuDeleteByList 26
GiftListSkuGet 27
GiftListSkuInsert 27
GiftListSkuSetPurchased 27
GiftListV2Filters 27
ImageInsertUpdate 28
ImageListByStockKeepingUnitId 28
ImageServiceCopyAllImagesFromSkuToSku 28
ImageServiceInsertUpdate 28
NewsletterGet 29
NewsletterGetAll 29
NewsletterGetAllByDate 29
NewsletterGetPaged 29
ProductActive 30
ProductEspecificationInsert 30
ProductEspecificationInsertByFieldId 30
ProductEspecificationInsertByList 30
ProductEspecificationInsertByListFieldIds 30
ProductEspecificationListByProductId 31
ProductEspecificationTextInsertByFieldId 31
ProductGet 31
ProductGetAllFromUpdateDateAndId 31
ProductGetByRefId 32
ProductGetSimilarCategory 32
ProductImageRemove 32
ProductInsertUpdate 32
ProductSetSimilarCategory 33
ServiceGet 33
ServiceInsertUpdate 33
ServicePriceGet 34
ServicePriceInsertUpdate 34
ServicePriceList 35
StockKeepingUnitActive 35
StockKeepingUnitComplementInsertUpdate 35
StockKeepingUnitEspecificationInsert 35
StockKeepingUnitEspecificationInsertByFieldId 35
 StockKeepingUnitEspecificationInsertByList 36
StockKeepingUnitEspecificationInsertByListFieldId 36
StockKeepingUnitEspecificationListBySkuId 36
StockKeepingUnitGet 36
StockKeepingUnitGetAllByProduct 37
StockKeepingUnitGetAllFromUpdatedDate 37
StockKeepingUnitGetAllFromUpdatedDateAndId 37
StockKeepingUnitGetByEan 37
StockKeepingUnitGetByManufacturerCode 38
StockKeepingUnitGetByRefId 38
StockKeepingUnitImageRemove 38
StockKeepingUnitImageRemoveByName 38
StockKeepingUnitInsertUpdate 39
StockKeepingUnitKitDeleteByParent 39
StockKeepingUnitKitInsertUpdate 39
StockKeepingUnitKitListByParent 40
StockKeepingUnitKitListBySkuId 40
StockKeepingUnitPriceUpdate 40
StockKeepingUnitPriceUpdateByRefId 41
StockKeepingUnitServiceGet 41
StockKeepingUnitServiceInsertUpdate 41
StockKeepingUnitServiceList 42
StoreGet 42
StoreList 42

Exemplos de integração na linguagem C# 42

Classes

BrandDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id da marca
Name string 100 Nome
Title string 200 Título
Description string max Descrição
Keywords string max Palavras chaves
IsActive bool nulável - Ativo
AdWordsRemarketingCod string 200 Código do AdWords
e
LomadeeCampaignCode string 200 Código da campanha do
Lomadee

BuyTogetherBuyGainDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do compre junto
Name string 128 Nome
Description string 512 Descrição
StartDate DateTime nulável - Data de início da
promoção
EndDate DateTime nulável - Data de término da
promoção
MinimumAmountSkuBenefit int nulável - Quantidade mínima
de skus para a
promoção ser válida
IsBenefitFreeShipping bool nulável - Promoção possui
frete grátis
IsActive bool nulável - Ativo
IdCollection Int nulável - Id da coleção que
pertence ao compre
junto

BuyTogetherDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do compre junto
Name string 128 Nome
Description string 512 Descrição
StartDate DateTime nulável - Data de início da
promoção
EndDate DateTime nulável - Data de término da
promoção
MinimumAmountSku int nulável - Quantidade mínima
de skus para a
promoção ser válida
DiscountFirstList decimal nulável - Desconto da
primeira lista
DiscountSecondList decimal nulável - Desconto da
segunda lista
IsActive bool nulável - Ativo

BuyTogetherTakeXPayYDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do compre junto
Name string 128 Nome
Description string 512 Descrição
StartDate DateTime nulável - Data de início da
promoção
EndDate DateTime nulável - Data de término da
promoção
MinimumAmountSkuCondition int nulável - Quantidade mínima
de skus para a
promoção ser válida
IsActive bool nulável - Ativo
IdCollection Int nulável - Id da coleção que
pertence ao compre
junto

CategoryDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id da categoria
Name string 100 Nome
FatherCategoryId int nulável - Id da categoria pai
Title string 150 Texto que será inserido
na tag TITLE do html
Description string max Descrição
Keywords string 200 Palavras chaves
IsActive bool nulável - Ativo
AdWordsRemarketingCod string 200 Código do AdWords
e
LomadeeCampaignCode string 200 Código da campanha do
Lomadee

GiftCardDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do GiftCard (este
campo é apenas para
consulta)
RedeptionCode string 255 Código de resgate
MultipleRedemptions bool nulável - Múltiplos resgates
MultipleCredits bool nulável - Múltiplos créditos
RestrictedToOwner bool nulável - Restrito ao dono
EmissionDate DateTime nulável - Data de emissão
ExpiringDate DateTime nulável - Data de expiração
StatusId short (Int16) nulável - Id do status
OwnerId string 20 CPF/CNPJ do usuário
Funds decimal nulável (18,2) Fundos (este campo é
apenas para consulta)

GiftCardTransactionItemDTO
Propriedades Tipos Tamanho Descrição
RedemptionCode string 255 Código de resgate
Value decimal nulável (18,2) Valor
TransactionAction enum TransactionAction - Ação da transação
(Credit, Debit)
TransactionConfirmed bool nulável - Transação confirmada
OrderId int nulável - Id da compra
StockKeepingUnitId int nulável - Id do sku

GiftListDTO
Propriedades Tipos Tamanho Descrição
GiftListId int nulável - Id da lista de presente
ClientId int nulável - Id do cliente
FileId int nulável - Id do arquivo
GiftListTypeId int nulável - Id do tipo da lista de
presente
ClientAddressId int nulável - Id do endereço do cliente
GiftCardId int nulável - Id do vale
Name string 300 Nome
Gifted string 200 Favorecido
Message string 1000 Mensagem
UrlFolder string 100 Url da pasta
DateCreated DateTime nulável - Data de criação
EventDate DateTime nulável - Data do evento
DateModified DateTime nulável - Data de alteração
IsActive bool nulável - Ativo
EventLocation string 300 Local do evento
EventCity string 200 Cidade do evento
EventState string 2 Estado do evento
IsPublic bool nulável - Público
Version int nulável - Versão da lista de
presente
GiftListMembers Lista de - Membros da lista de
GiftListMemberDTO presente.

GiftListMemberDTO
Propriedades Tipos Tamanho Descrição
GiftListMemberId int nulável -
GiftListId int nulável - Id da lista de casamento
ClientId int nulável - Id do cliente
Title string 100 Título
Name string 100 Nome
Surname string 100 Sobrenome
Mail string 100 E=mail
Text1 string 200 Campo livre definido no
cadastro da lista
Text2 string 200 Campo livre definido no
cadastro da lista
IsAdmin bool nulável - Administrador
IsActive bool nulável - Ativo

GiftListStockKeepingUnitDTO
(Skus que pertencem a uma lista de presente)

Propriedades Tipos Tamanho Descrição

GiftListSkuId int nulável - Id da lista de presente
sku
GiftListId int nulável - Id da lista de presente
SkuId int nulável - Id do sku
OrderId int nulável - Id do pedido
InsertedByClientId int nulável - Id do cliente que inseriu
ItemValue decimal nulável (18,2) Valor do item
FreightAndServicesValue decimal nulável (18,2) Valor do frete e serviços
DateCreated DateTime nulável - Data de criação
DatePurchased DateTime nulável - Data da compra
_IsOrderFinished bool nulável - É pedido finalizado
OrderResponseMessage string 1000 Mensagem de resposta
do pedido
OrderMessage string 1000 Mensagem do pedido
OrderMessageFrom string 100 Remetente da
mensagem
OrderMessageTo string 100 Destinatário da
mensagem
WishedByClientId int - Id do cliente que deseja
o sku

GiftListTypeDTO
Propriedades Tipos Tamanho Descrição
GiftListTypeId int nulável - Id do tipo de lista
Name string 200 Nome
Description string 500 Descrição
IsMessageAvailable bool nulável - Mensagem disponível
IsStockImpact bool nulável - Altera estoque
ShipToListOwner bool nulável - Enviar para o dono
DaysToExpireToVisitors int nulável - Dias para expirar para
visitantes
DaysToExpireToMembers int nulável - Dias para expirar para
donos
DaysToEventMin int nulável - Dias mínimos para o
evento
DaysToEventMax int nulável - Dias máximos para o
evento
MemberMin int nulável - Quantidade de membros
mínima
MemberMax int nulável - Quantidade de membros
máxima
MemberTitle string 500 Título dos membros
TextTitle1 string 100 Campo livre que ficará
definido para as listas
desse tipo
TextTitle2 string 100 Campo livre que ficará
definido para as listas
desse tipo
IsPublic bool nulável - Público
IsProtected bool nulável - Protegido
IsUnique bool nulável - Único
IsActive bool nulável - Ativo
Version int nulável - Versão

ImageDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id da imagem
ArchiveFormatId int nulável - Id do formato do arquivo
ArchiveParentId int nulável - Id do arquivo pai
ArchiveTypeId int nulável - Id do tipo de arquivo
DateLastModified DateTime nulável - Data de última alteração
Description string 100 Descrição
FileLocation string 500 Localização do arquivo
no servidor
Height int nulável - Altura
HeightUnitMeasure string 50 Unidade de medida
Name string 100 Nome/Campo Tag
Width int nulável - Largura
WidthUnitMeasure string 50 Unidade de medida
StockKeepingUnitId int nulável - Id do sku
IsMain bool nulável - É principal
Label string 500 Label da imagem
Tag string 500 Tag da imagem
Url string max Url da imagem

ProductDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do produto
Name string 150 Nome do produto
DepartmentId int nulável - Id do departamento
CategoryId int nulável - Id da categoria. Caso
possua sku e não seja
preenchido,
desativar-se-á os skus
referentes a este
produto e o próprio
produto.
BrandId int nulável - Id da marca
LinkId string 255 Url do produto (sem
espaços e sem
caracteres especiais)
RefId string 200 Código de referência
IsVisible bool nulável - Visível
Description string max Descrição
DescriptionShort string max Descrição resumida
(vitrine)
ReleaseDate DateTime nulável - Data de lançamento
KeyWords string max Palavras-chaves
Title string 150 Texto que será
inserido na tag TITLE
do html
IsActive bool nulável - O campo IsActive
define se o produto
está ativo ou inativo. É
necessário utilizar o
método
"ProductActivate"​ para
ativar um produto.
Caso seja preenchido
como false, o produto
será desativado.
TaxCode string 50 Código fiscal
MetaTagDescription string max MetaTagDescription
SupplierId int nulável - Id do fornecedor
ShowWithoutStock bool - Exibe sem estoque
ListStoreId lista de int - Lista com os ids das
lojas em que o produto
pode ser exibido
(multiloja)
AdWordsRemarketingCode string 200 Código do AdWords
LomadeeCampaignCode string 200 Código da campanha
do Lomadee

ProductFieldIdDTO
Propriedades Tipos Tamanho Descrição
productid int - Id do produto
fieldId int - Id do campo
fieldValues lista de string max Valor(es) do campo

ProductFieldNameDTO
Propriedades Tipos Tamanho Descrição
productid int - Id do produto
fieldId fieldName 100 Nome do campo
fieldValues lista de string max Valor(es) do campo

ServiceDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do serviço
Name string 100 Nome
IsActive bool nulável - Ativo
IsVisibleOnProduct bool nulável - Visível nos produtos
IsVisibleOnCart bool nulável - Visível no carrinho
IsVisibleOnService bool nulável - Visível na tela de
serviços
IsFile bool nulável - Arquivo
(possibilidade de
upload no checkout)
IsGiftCard bool nulável - Vale presente
IsRequired bool nulável - É obrigatório

ServicePriceDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do preço de
serviço
ServiceId int nulável - Id do serviço
Name string 100 Nome
ListPrice decimal nulável (18,2) Preço De
Price decimal nulável (18,2) Preço Por (preço
normal)
Service ServiceDTO - Serviço

StockKeepingUnitComplementDTO
Propriedades Tipos Tamanho Descrição
StockKeepingUnitId int - Id do sku
StockKeepingUnitComplements lista de int - Todos os ids de
skus que são
complementos de
um determinado
tipo
ComplementType enum - Tipo do
complemento
(Acessório,
sugestão ou
similar)

StockKeepingUnitDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do sku
ProductId int nulável - Id do produto
IsActive bool nulável - O campo isActive define se
o sku está ativo ou inativo.
É necessário utilizar o
método
"StockKeepingUnitActivate"
para ativar um sku. Caso
seja preenchido como
false, o sku será
desativado.
Name string 200 Nome do sku
RefId string 50 Código de referência
CostPrice decimal nulável (18,2) Preço de custo*
ListPrice decimal nulável (18,2) Preço De*
Price decimal nulável (18,2) Preço Por (preço normal) *
Height decimal nulável (18,4) Altura*
Length decimal nulável (18,4) Comprimento*
Width decimal nulável (18,4) Largura*
WeightKg decimal nulável (18,4) Peso em grama(g)*
RealHeight decimal nulável (18,4) Altura real*
RealLength decimal nulável (18,4) Comprimento real*
RealWidth decimal nulável (18,4) Largura real*
RealWeightKg decimal nulável (18,4) Peso em grama(g) real*
ModalId int nulável - Refere-se à modalidade de
frete
(1- leve,
2- pesado,
3-refrigerado,
4-químico)
CubicWeight decimal nulável (18,4) Peso cúbico
InternalNote string max Este campo não é mais
utilizado no sistema
embora ainda exista
(depreciado)
IsKit bool nulável - Sku é do tipo kit (uma vez
kit, o sku não poderá
deixar de ser kit)
ProductName string 150 Nome do produto
IsAvaiable bool nulável - Disponível (depreciado)
StockKeepingUnitEans lista de - Código de barras (EAN13).
StockKeepingUnitEanDTO Caso um sku estiver ativo,
o RefId estiver vazio e o
ean não for preenchido
inativar-se-á o sku
DateUpdated DateTime nulável - Data de atualização
RewardValue decimal nulável (18,2) Código de fidelidade
EstimatedDateArrival DateTime nulável - Data de pré-venda
ManufacturerCode string 100 Código do fabricante
ComercialConditionId int nulável - Id da condição comercial
MeasurementUnit string - Unidade de medida
UnitMultiplier decimal nulável - Multiplicador da unidade
OBS.: Não existe venda de produtos sem estoque na Vtex. Caso o sku não possua imagem ou ocorra
mudança da categoria do produto inativar-se-á o sku. Marcar a flag Kit de um Sku resultará em
inativação do sku até que os skus-componentes do kit sejam associados. Se o sku-componente de um
kit for inativado, o Sku kit também será.

*Caso não sejam preenchidos desativar-se-á o sku.

StockKeepingUnitEanDTO
Propriedades Tipos Tamanho Descrição
Ean String 50 Código de barras
(único). Esta
informação é
meramente informativa
e não é obrigatória*.

*Para que um sku seja ativado é necessário que ele tenha código de referência ou EAN.

StockKeepingUnitFieldIdDTO
Propriedades Tipos Tamanho Descrição
idSku int - Id do sku
fieldId int - Id do campo
fieldValues lista de string max Valor(es) do campo

StockKeepingUnitFieldNameDTO
Propriedades Tipos Tamanho Descrição
idSku int - Id do sku
fieldId fieldName 100 Nome do campo
fieldValues lista de string max Valor(es) do campo

Propriedades Tipos Tamanho Descrição

Id int nulável - Id do kit
StockKeepingUnitParent int nulável - Id do sku pai
StockKeepingUnitId int nulável - Id do sku
Amount int nulável - Quantidade de itens
UnitPrice decimal nulável (18,2) Preço unitário
StockKeepingUnitQuantityDTO
Propriedades Tipos Tamanho Descrição
StockKeepingUnitId int - Id do sku
StockKeepingUnitComplements lista de int - Todos os ids de
skus que são
complementos de
um determinado
tipo
ComplementType enum - Tipo do
complemento
(Acessório,
sugestão ou
similar)

StockKeepingUnitServiceDTO
Propriedades Tipos Tamanho Descrição
Id int nulável - Id do serviço do sku
ServiceId int nulável - Id do serviço. Ex.:
Garantia Estendida,
Montagem
ServicePriceId int nulável - Id do preço do
serviço
StockKeepingUnitId int nulável - Id do sku
Name string 50 Nome do serviço
Description string 100 Descrição
IsActive bool nulável - Ativo
ServicePrice ServicePriceDTO - Preço do serviço
Methods

BrandGet
Obter as informações sobre uma determinado marca pelo id​.

Parâmetros de entrada Tipo

idBrand int

Parâmetros de saída Tipo

objeto BrandDTO

BrandGetByName
Obter as informações sobre uma determinado marca pelo nome​.

Parâmetros de entrada Tipo

nameBrand string
Parâmetros de saída Tipo
objeto BrandDTO

BrandInsertUpdate
Inserir ou atualizar os dados de uma marca​.

Parâmetros de entrada Tipo

brand BrandDTO

Parâmetros de saída Tipo

objeto BrandDTO

Dados obrigatórios (BrandDTO) Tipo

Id* int
Name string
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente.

BuyTogetherBuyGainInsertUpdate
Insere/Altera um compre junto do tipo compre e ganhe.

Parâmetros de entrada Tipo

objBuyTogetherBuyGainDTO BuyTogetherBuyGainDTO

Parâmetros de saída Tipo

objeto BuyTogetherBuyGainDTO

BuyTogetherDeleteById
Deleta um compre junto através do identificador do mesmo.

Parâmetros de entrada Tipo

buyTogetherId int

BuyTogetherInsertUpdate
Insere/Altera um compre junto.

Parâmetros de entrada Tipo

objBuyTogetherDTO BuyTogetherDTO

Parâmetros de saída Tipo

objeto BuyTogetherDTO

BuyTogetherSkuListInsertUpdate
Anexa as listas de skus a um determinado de compre junto ou Altera as listas de skus de um
determinado compre junto.

Parâmetros de entrada Tipo

buyTogetherId int
firstListStockKeepingUnit Lista de int
secondListStockKeepingUnit Lista de int

CategoryGet
Obter as informações sobre uma determinada categoria pelo id​.

Parâmetros de entrada Tipo

idCategory Int

Parâmetros de saída Tipo

objeto CategoryDTO

CategoryGetByName
Obter as informações sobre uma determinada categoria pelo nome​.

Parâmetros de entrada Tipo

nameCategory String
Parâmetros de saída Tipo
objeto CategoryDTO

CategoryInsertUpdate
Inserir ou atualizar os dados de uma categoria​.

Parâmetros de entrada Tipo

category CategoryDTO

Parâmetros de saída Tipo

objeto CategoryDTO

Dados obrigatórios (CategoryDTO) Tipo

Id* int
Name string
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente.

CollectionGet
Obter as informações sobre uma determinada coleção.

Parâmetros de entrada Tipo

Id int

Parâmetros de saída Tipo

objeto CollectionDTO

GiftCardGet
Obter as informações sobre um determinado gift card.

Parâmetros de entrada Tipo

Id int

Parâmetros de saída Tipo

objeto GiftCardDTO
GiftCardGetByRedeptionCode
Obter as informações sobre um determinado gift card.

Parâmetros de entrada Tipo

redeptionCode string

Parâmetros de saída Tipo

giftCard GiftCardDTO

GiftCardInsertUpdate
Inserir ou atualizar os dados de um gift card.

Parâmetros de entrada Tipo

giftCard GiftCardDTO

Parâmetros de saída Tipo

objeto GiftCardDTO

Dados obrigatórios (GiftCardDTO) Tipo

StatusId int
OwnerId string
EmissionDate DateTime
ExpiringDate DateTime

GiftCardTransactionItemInsert
Inserir uma transação relacionada a um gift card.

Parâmetros de entrada Tipo

giftCardTransactionItem GiftCardTransactionItemDTO

Parâmetros de saída Tipo

Success bool

Dados obrigatórios (GiftCardTransactionItemDTO) Tipo

RedemptionCode string
Value decimal
TransactionAction enum TransactionAction
TransactionConfirmed bool

GiftCardTransactionItemSetStatus
Ativa ou inativa uma débito/crédito baseado no id da compra e id do sku.

Parâmetros de entrada Tipo

OrderId int
StockKeepingUnitId int
Quantity int
IsActive bool

Parâmetros de saída Tipo

Success bool

GiftListGet
Obter as informações de uma lista.

Parâmetros de entrada Tipo

IdGiftList int

Parâmetros de saída Tipo

objeto GiftListDTO

GiftListGetAllBetweenEventDateIntervalAndId
Obter as informações das listas por eventos dentro de um dado intervalo de data.

Parâmetros de entrada Tipo

eventDateBegin DateTime
eventDateEnd Datetime
startingGiftListId int nulável
topRows int

Parâmetros de saída Tipo

lista de objetos GiftListDTO

GiftListGetAllFromCreatedDateAndId
Obter as informações das listas criadas dentro de um dado intervalo de data.

Parâmetros de entrada Tipo

createdDate Datetime
startingGiftListId int nulável
topRows int

Parâmetros de saída Tipo

lista de objetos GiftListDTO

GiftListGetAllFromModifiedDateAndId
Obter as informações das listas alteradas dentro de um dado intervalo de data.

Parâmetros de entrada Tipo

modifiedDate Datetime
startingGiftListId int nulável
topRows int

Parâmetros de saída Tipo

lista de objetos GiftListDTO

GiftListGetByClient
Obter as informações de uma lista de um determinado cliente.

Parâmetros de entrada Tipo

clienteId int
Parâmetros de saída Tipo
lista de objetos GiftListDTO

GiftListGetByCreatedDate
Obter uma lista de gift list criados a partir de uma data.

Parâmetros de entrada Tipo

createdDate DateTime

Parâmetros de saída Tipo

lista de objetos GiftListDTO

GiftListGetByGifted
Obter uma lista de gift list criados a partir de uma data.

Parâmetros de entrada Tipo

createdDate DateTime

Parâmetros de saída Tipo

lista de objetos GiftListDTO

GiftListGetByModifiedDate
Obter uma lista de gift list alterados a partir de uma data.

Parâmetros de entrada Tipo

modifiedDate DateTime

Parâmetros de saída Tipo

lista de objetos lista de objetos GiftListDTO

GiftListGetType
Obter as informações de um tipo de lista.

Parâmetros de entrada Tipo

gitListTypeId int
Parâmetros de saída Tipo
objeto GiftListTypeDTO

GiftListInsertUpdate
Inserir ou atualizar uma lista.

Parâmetros de entrada Tipo

giftList GiftListDTO

Parâmetros de saída Tipo

objeto GiftListDTO

Dados obrigatórios (GiftListDTO) Tipo

ClientId int
GiftListTypeId int
ClientAddressId int
Gifted string
UrlFolder string
EventDate DateTime
DataCreateDT DateTime
GiftListMembers** Lista de objetos GiftListMemberDTO
**Caso a lista seja da Versão 2(Campo Version esteja preenchido como 2) e não tiver os membros
previamente cadastrados, deve-se preencher esse campo, caso contrário a lista ficar-se-á inativa.

GiftListMemberDelete
Deletar um membro de uma lista.

Parâmetros de entrada Tipo

GiftListMemberId int
GiftListId int

GiftListMemberInsertUpdate
Inserir um membro em uma lista.

Parâmetros de entrada Tipo

giftListMember lista de objetos GiftListMemberDTO

Dados obrigatórios (GiftListDTO) Tipo

GiftListId int
Nome int
Sobrenome int
isAdmin string
isActive string
ClientId* int
*Deve conter pelo menos um membro em uma GiftList com o campo ClientId preenchido, caso contrário
não será possível gerenciá-la.

Parâmetros de saída Tipo

lista de objetos GiftListMemberDTO

GiftListSearch
Obter uma lista de gift list dado uma consulta.

Parâmetros de entrada Tipo

clientName string
eventLocation string
eventCity string
eventDate DateTime nulável

Parâmetros de saída Tipo

lista de objetos GiftListDTO

GiftListSkuDelete
Remover um sku de uma lista.

Parâmetros de entrada Tipo

giftListId int
skuId int
Quantity int
GiftListSkuDeleteByList
Remover uma coleção de skus de uma lista.

Parâmetros de entrada Tipo

giftListId int
skuQuantity lista de objetos skuQuantityDTO

GiftListSkuGet
Obter uma coleção de skus a partir de uma lista.

Parâmetros de entrada Tipo

idGiftList int

Parâmetros de saída Tipo

lista de objetos GiftListStockKeepingUnitDTO

GiftListSkuInsert
Inserir sku em uma lista.

Parâmetros de entrada Tipo

giftListSku GiftListStockKeepingUnitDTO

Parâmetros de saída Tipo

objeto GiftListStockKeepingUnitDTO

Dados obrigatórios (GiftListStockKeepingUnitDTO) Tipo

GiftListId int
SkuId int
InsertedByClientId int
WishedByClientId* int

GiftListSkuSetPurchased
Definir um sku da lista como "comprado".

Parâmetros de entrada Tipo

giftListId int
skuId int
Quantity int
orderId int

GiftListV2Filters
Obter uma lista de gift list dado uma consulta.

Parâmetros de entrada Tipo

giftListTypeId int nulável
giftListId int nulável
clientId int nulável
eventDateSince DateTime nulável
eventDateUntil DateTime nulável
isActive bool nulável

Parâmetros de saída Tipo

lista de objetos GiftListDTO

ImageInsertUpdate
Inserir uma nova imagem (por enquanto não temos o update funcionando).

Parâmetros de entrada Tipo

image ImageDTO

ImageListByStockKeepingUnitId
Lista todas as imagens de um dado sku e um dado tipo. (Caso seja passado nulo será retornado todos
os arquivos. Para consulta apenas de imagem passar o id 10).

Parâmetros de entrada Tipo

StockKeepingUnitId int
ArchiveTypeId int nulável

ImageServiceCopyAllImagesFromSkuToSku
Copia todas as imagens de um sku origem para outro sku destino.

Parâmetros de entrada Tipo

stockKeepingUnitIdFrom int
stockKeepingUnitIdTo int

ImageServiceInsertUpdate
Inserir uma imagem relacionada a um sku.

Parâmetros de entrada Tipo

urlImage string
imageName string
stockKeepingUnitId int
fileId int nulável

NewsletterGet
Obter as informações sobre uma determinada Newsletter.

Parâmetros de entrada Tipo

NewsId int

Parâmetros de saída Tipo

objeto NewsletterDTO

NewsletterGetAll
Obter as informações de todas as Newsletters cadastradas.

Parâmetros de saída Tipo

lista de objetos NewsletterDTO

NewsletterGetAllByDate
Obter as informações de todas as Newsletters cadastradas a partir da data inicial e data final.

Parâmetros de entrada Tipo

BeginDate DateTime
EndDate DateTime

Parâmetros de saída Tipo

lista de objetos NewsletterDTO
NewsletterGetPaged
Obter as informações de Newsletters de forma paginada.

Parâmetros de entrada Tipo

page int
quantity int

Parâmetros de saída Tipo

Lista de objetos NewsletterDTO

ProductActive
Ativar um determinado produto.

Parâmetros de entrada Tipo

idProduct int

ProductEspecificationInsert
Inserir uma especificação para um produto a partir do nome do campo.

Parâmetros de entrada Tipo

idProduct int
fieldName string
fieldValues lista de string

ProductEspecificationInsertByFieldId
Inserir uma especificação para um produto a partir do id do campo.

Parâmetros de entrada Tipo

idProduct int
fieldId int
fieldValues lista de string
ProductEspecificationInsertByList
Inserir uma ou mais especificações para um produto ou mais produtos a partir de uma lista, usando como
base o nome do campo.

Parâmetros de entrada Tipo

listProductFieldName lista de objeto ProductFieldNameDTO

ProductEspecificationInsertByListFieldIds
Inserir uma ou mais especificações para um produto ou mais produtos a partir de uma lista, usando como
base o id do campo.

Parâmetros de entrada Tipo

listProductFieldId lista de objeto ProductFieldIdDTO

ProductEspecificationListByProductId
Busca todas as especificações de um dado id de produto.

Parâmetros de entrada Tipo

productId int

Parâmetros de saída Tipo

lista de objetos FieldDTO

ProductEspecificationTextInsertByFieldId
Inserir uma especificação do tipo texto longo para um produto a partir do id do campo. (Método
depreciado)

Parâmetros de entrada Tipo

idProduct int
fieldId int
fieldValues lista de string
OBS.: Este método está em desuso e em breve será retirado do WebService.

ProductGet
Obter as informações sobre um determinado produto.

Parâmetros de entrada Tipo

idProduct int
Parâmetros de saída Tipo
objeto ProductDTO

ProductGetAllFromUpdateDateAndId
Obter todos os produtos que foram alterados dado o id de início e a data de atualização.

Parâmetros de entrada Tipo

dateUpdate DateTime
ProductId int
topRows int

Parâmetros de saída Tipo

objeto ProductDTO

ProductGetByRefId
Obter as informações sobre um determinado produto a patir de um id de referência.

Parâmetros de entrada Tipo

refId string

Parâmetros de saída Tipo

objeto ProductDTO

ProductGetSimilarCategory
Buscar as categorias similares de um dado produto.

Parâmetros de entrada Tipo

productId int

Parâmetros de saída Tipo

lista int
ProductImageRemove
Remover as imagens de um produto. (Método depreciado)

Parâmetros de entrada Tipo

idProduct int

ProductInsertUpdate
Inserir ou atualizar os dados de um produto.

Parâmetros de entrada Tipo

productVO ProductDTO

Parâmetros de saída Tipo

objeto ProductDTO

Dados obrigatórios (ProductDTO) Tipo

Id* int
Name string
BrandId int
CategoryId int
DepartmentId int
LinkId string
IsActive bool
IsVisible bool
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente.

ProductSetSimilarCategory
Definir categoria similar para um dado id de produto.

Parâmetros de entrada Tipo

productId int
categoryId int

ServiceGet
Obter as informações sobre um determinado serviço.

Parâmetros de entrada Tipo

idService int
Parâmetros de saída Tipo
objeto ServiceDTO

ServiceInsertUpdate
Inserir ou atualizar os dados de um serviço.

Parâmetros de entrada Tipo

service ServiceDTO

Parâmetros de saída Tipo

objeto ServiceDTO

Dados obrigatórios (ServiceDTO) Tipo

Id* int
Name string
IsActive bool
IsFile bool
IsGiftCard bool
IsRequired bool
IsVisibleOnCart bool
IsVisibleOnProduct bool
IsVisibleOnService bool
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente.

ServicePriceGet
Obter as informações sobre o preço de um serviço.

Parâmetros de entrada Tipo

idServicePrice int

Parâmetros de saída Tipo

objeto ServicePriceDTO
ServicePriceInsertUpdate
Inserir ou alterar o preço de um serviço.

Parâmetros de entrada Tipo

servicePrice ServicePriceDTO

Parâmetros de saída Tipo

objeto ServicePriceDTO

Dados obrigatórios (ServicePriceDTO) Tipo

Id* int
ServiceId int
Name string
Price decimal
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente.

ServicePriceList
Obter uma lista de preços de um determinado serviço.

Parâmetros de entrada Tipo

idService int

Parâmetros de saída Tipo

objeto ServicePriceDTO

StockKeepingUnitActive
Ativar um determinado sku.

Parâmetros de entrada Tipo

idStockKeepingUnit int

StockKeepingUnitComplementInsertUpdate
Definir a vinculação de skus complementares (Acessório, similar e sugestão).

Parâmetros de entrada Tipo

StockKeepingUnitComplement StockKeepingUnitComplementDTO
StockKeepingUnitEspecificationInsert
Inserir uma especificação para um sku a partir do nome do campo.

Parâmetros de entrada Tipo

idSku int
fieldName string
fieldValues lista de string

StockKeepingUnitEspecificationInsertByFieldId
Inserir uma especificação para um sku a partir do id do campo.

Parâmetros de entrada Tipo

idSku int
fieldId int
fieldValues lista de string

StockKeepingUnitEspecificationInsertByList
Inserir uma ou mais especificações para um produto ou mais produtos a partir de uma lista, usando como
base o nome do campo.

Parâmetros de entrada Tipo

listStockKeepingUnitName lista de objeto
StockKeepingUnitFieldNameDTO

StockKeepingUnitEspecificationInsertByListFieldId
Inserir uma ou mais especificações para um produto ou mais produtos a partir de uma lista, usando como
base o id do campo.

Parâmetros de entrada Tipo

listStockKeepingUnitdId lista de objeto StockKeepingUnitFieldIdDTO

StockKeepingUnitEspecificationListBySkuId
Busca todas as especificações de um dado id de sku.

Parâmetros de entrada Tipo

skuId int
Parâmetros de saída Tipo
lista de objetos FieldDTO

StockKeepingUnitGet
Obter as informações sobre um determinado sku.

Parâmetros de entrada Tipo

Id int

Parâmetros de saída Tipo

objeto StockKeepingUnitDTO

StockKeepingUnitGetAllByProduct
Obter todos os skus de um determinado produto.

Parâmetros de entrada Tipo

IdProduto int

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitDTO

StockKeepingUnitGetAllFromUpdatedDate
Obter todos os skus que foram alterados a partir de uma data.

Parâmetros de entrada Tipo

dateUpdated DateTime

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitDTO
StockKeepingUnitGetAllFromUpdatedDateAndId
Obter todos os skus que foram alterados a partir de uma data e id.

Parâmetros de entrada Tipo

dateUpdated DateTime
startingStockKeepingUnitId Int?
topRows int

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitDTO

StockKeepingUnitGetByEan
Obter as informações sobre um determinado sku a partir de um EAN13.

Parâmetros de entrada Tipo

EAN13 string

Parâmetros de saída Tipo

objeto StockKeepingUnitDTO

StockKeepingUnitGetByManufacturerCode
Obter todos os skus de um determinado código de fabricante.

Parâmetros de entrada Tipo

manufacturer string

Parâmetros de saída Tipo

lista de objeto StockKeepingUnitDTO

StockKeepingUnitGetByRefId
Obter as informações sobre um determinado sku.

Parâmetros de entrada Tipo

CodigoReferenciaSKU string

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitDTO
StockKeepingUnitImageRemove
Remover todas as imagens relacionadas a um dado sku.

Parâmetros de entrada Tipo

stockKeepingUnitId int

StockKeepingUnitImageRemoveByName
Remover todas as imagens a partir de um dado nome.

Parâmetros de entrada Tipo

imageName string

StockKeepingUnitInsertUpdate
Inserir ou atualizar os dados de um sku (Stock Keeping Unity).

Parâmetros de entrada Tipo

stockKeepingUnitVO StockKeepingUnitDTO

Parâmetros de saída Tipo

objeto StockKeepingUnitDTO

Dados obrigatórios (StockKeepingUnitDTO) Tipo

Id* int
ProductId int
ModalId int
Name string
IsActive bool
IsKit bool
CostPrice decimal
Price decimal
ListPrice decimal
WeightKg decimal
Height decimal
Length decimal
Width decimal
CubicWeight decimal
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente.

StockKeepingUnitKitDeleteByParent
Remover todos os itens de um determinado kit.

Parâmetros de entrada Tipo

idSkuParent int

StockKeepingUnitKitInsertUpdate
Inserir ou atualizar os dados de um kit.

Parâmetros de entrada Tipo

stockKeepingUnitKit StockKeepingUnitKitDTO

Parâmetros de saída Tipo

objeto StockKeepingUnitKitDTO

Dados obrigatórios (StockKeepingUnitKitDTO) Tipo

Id int
StockKeepingUnitId int
StockKeepingUnitParent int
Amount int
UnitPrice decimal

StockKeepingUnitKitListByParent
Obter as informações sobre os itens (skus) que compõem um determinado kit.

Parâmetros de entrada Tipo

idSkuParent int

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitKitDTO
StockKeepingUnitKitListBySkuId
Obter as informações sobre os kits aonde um dado sku é componente.

Parâmetros de entrada Tipo

idSku int

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitKitDTO

StockKeepingUnitPriceUpdate
Atualizar os preços de um dado sku a partir de seu id.

Parâmetros de entrada Tipo

stockKeepintUnitId int
price decimal
listPrice decimal
costPrice decimal

StockKeepingUnitPriceUpdateByRefId
Atualizar os preços de um dado sku a partir de seu refid.

Parâmetros de entrada Tipo

stockKeepintUnitRefId string
price decimal
listPrice decimal
costPrice decimal

StockKeepingUnitServiceGet
Obter as informações sobre um determinado serviço de um sku.

Parâmetros de entrada Tipo

idStockKeepingUnitService int

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitServiceDTO
StockKeepingUnitServiceInsertUpdate
Inserir ou atualizar os dados de um serviço sku.

Parâmetros de entrada Tipo

stockKeepingUnitService StockKeepingUnitServiceDTO

Parâmetros de saída Tipo

objeto StockKeepingUnitServiceDTO

Dados obrigatórios (StockKeepingUnitServiceDTO) Tipo

Id* int
ServicePriceId int
StockKeepingUnitId int
Name string
IsActive bool
*O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo
integrador. Este campo é auto incremento e será retornado após o insert, porém o update só ocorrerá
caso o id retornado seja informado.

StockKeepingUnitServiceList
Obter todos os serviços de um determinado sku.

Parâmetros de entrada Tipo

idSku int

Parâmetros de saída Tipo

lista de objetos StockKeepingUnitServiceDTO

StoreGet
Busca os dados da loja a partir de um dado id.

Parâmetros de entrada Tipo

storeId int

Parâmetros de saída Tipo

objeto StoreDTO
StoreList
Lista todas as lojas (multidomínio).

Parâmetros de saída Tipo

Lista de objetos StoreDTO

Exemplos de integração na linguagem C#

Os exemplos e esta documentação estão disponíveis para download no link:

https://github.com/vtex/vcs.integration.samples

Também recomendamos o uso da ferramenta SoapUI para auxiliar no desenvolvimento da integração.

Link do projeto: ​http://sourceforge.net/projects/soapui/files/soapui/3.6.1/

Link do instalador:
http://sourceforge.net/projects/soapui/files/soapui/3.6.1/soapUI-x32-3_6_1.exe/download