Manual do WebService da VTEX
Versão 16.0 – 25/10/2013
Índice
Classes........................................................................................................... 2
AddressDTO................................................................................................. 2
AddressOrderDTO........................................................................................ 3
BrandDTO.................................................................................................... 3
BuyTogetherBuyGainDTO............................................................................ 4
BuyTogetherDTO......................................................................................... 4
BuyTogetherTakeXPayYDTO.........................................................................4
CategoryDTO............................................................................................... 5
ClientCandidateDTO.................................................................................... 5
ClientDTO.................................................................................................... 5
ClientExtendedDTO..................................................................................... 9
ClientFieldDTO............................................................................................. 9
CollectionDTO............................................................................................. 9
DistributionCenterDTO................................................................................ 9
EmailQueueDTO........................................................................................ 10
EmailQueueTypeDTO................................................................................. 10
FieldDTO.................................................................................................... 11
FreightDTO................................................................................................ 11
FreightScheduledDateOptionDTO..............................................................11
FreightStockKeepingUnitContextDTO........................................................11
FreightStockKeepingUnitDTO....................................................................12
FreightValueDTO........................................................................................ 12
GiftCardDTO.............................................................................................. 12
GiftCardTransactionItemDTO.....................................................................13
GiftListDTO................................................................................................ 13
GiftListMemberDTO................................................................................... 14
GiftListStockKeepingUnitDTO....................................................................14
GiftListTypeDTO......................................................................................... 15
ImageDTO................................................................................................. 15
1
IntegrationInterfaceDTO............................................................................18
NewsletterDTO.......................................................................................... 18
OrderDeliveryDTO..................................................................................... 18
OrderDiscountDTO.................................................................................... 19
OrderDTO.................................................................................................. 19
OrderInteractionDTO................................................................................. 20
OrderInvoiceDTO....................................................................................... 20
OrderInvoiceStockKeepingUnitDTO...........................................................20
OrderItemDiscountDTO............................................................................. 20
OrderItemDTO........................................................................................... 21
OrderItemServiceDTO............................................................................... 21
OrderPaymentDTO.................................................................................... 23
OrderStatusDTO........................................................................................ 24
PaymentDTO............................................................................................. 24
ProductDTO............................................................................................... 24
ProductFieldIdDTO..................................................................................... 25
ProductFieldNameDTO............................................................................... 25
ServiceDTO............................................................................................... 25
ServicePriceDTO........................................................................................ 25
StockKeepingUnitComplementDTO...........................................................26
StockKeepingUnitDTO............................................................................... 26
StockKeepingUnitEanDTO.........................................................................27
StockKeepingUnitFieldIdDTO.....................................................................27
StockKeepingUnitFieldNameDTO...............................................................27
StockKeepingUnitKitDTO...........................................................................27
StockKeepingUnitQuantityDTO..................................................................27
StockKeepingUnitServiceDTO....................................................................28
StoreDTO................................................................................................... 28
WareHouseIStockableDTO.........................................................................28
ZipCodeDTO.............................................................................................. 28
Métodos........................................................................................................ 29
AddressByAddressClient............................................................................29
AddressGetByClientId................................................................................ 30
AddressGetByClientIdV3............................................................................30
AddressInsertByClientId............................................................................ 30
2
AddressInsertByCpfCnpj............................................................................ 30
BrandGet................................................................................................... 31
BrandGetByName...................................................................................... 31
BrandInsertUpdate.................................................................................... 31
BuyTogetherBuyGainInsertUpdate.............................................................32
BuyTogetherDeleteById............................................................................. 32
BuyTogetherInsertUpdate..........................................................................32
BuyTogetherSkuListInsertUpdate...............................................................32
BuyTogethertakeXPayYInsertUpdate.........................................................32
CategoryGet.............................................................................................. 33
CategoryGetByName................................................................................. 33
CategoryInsertUpdate............................................................................... 33
ClientCandidateDeleteByCpfOrEmail.........................................................34
ClientCandidateDeleteById.......................................................................34
ClientCandidateGet................................................................................... 34
ClientCandidateInsert................................................................................ 34
ClientGet................................................................................................... 34
ClientGetAllFromCreatedDateAndId..........................................................35
ClientGetByCPF......................................................................................... 35
ClientGetByEmail...................................................................................... 35
ClientGetByEmailV3.................................................................................. 35
ClientGetByGuid........................................................................................ 36
ClientGetExtendedInfo.............................................................................. 36
ClientGetExtendedInfoByCPF....................................................................36
ClientGetV3............................................................................................... 36
ClientInsertUpdate.................................................................................... 37
ClientRewardGet....................................................................................... 37
ClientRewardGetByCPF.............................................................................. 37
ClientRewardUpdate.................................................................................. 38
ClientRewardUpdateByCPF........................................................................38
CollectionGet............................................................................................. 38
CollectionInsertUpdate.............................................................................. 38
DistributionCenterGet............................................................................... 39
DistributionCenterGetByTaxId...................................................................39
EmailQueueConfirmSending......................................................................39
3
EmailQueueGetAllBetweenTimeIntervalAndEmailTypeId...........................40
EmailQueueNotSendedByType..................................................................40
FreightCalculate........................................................................................ 40
FreightCalculateV3.................................................................................... 40
FreightGet................................................................................................. 41
FreightGetAll.............................................................................................. 41
FreightInsertUpdate................................................................................... 41
FreightValueDeleteByFreight.....................................................................42
FreightValueInsertUpdate..........................................................................42
FreightValueInsertUpdateByList................................................................42
GiftCardGet............................................................................................... 43
GiftCardGetByRedeptionCode...................................................................43
GiftCardInsertUpdate................................................................................. 43
GiftCardTransactionItemInsert...................................................................43
GiftCardTransactionItemSetStatus.............................................................44
GiftListGet................................................................................................. 44
GiftListGetAllBetweenEventDateIntervalAndId..........................................44
GiftListGetAllFromCreatedDateAndId........................................................45
GiftListGetAllFromModifiedDateAndId.......................................................45
GiftListGetByClient.................................................................................... 45
GiftListGetByCreatedDate.........................................................................46
GiftListGetByGifted.................................................................................... 46
GiftListGetByModifiedDate........................................................................46
GiftListGetType.......................................................................................... 46
GiftListInsertUpdate.................................................................................. 47
GiftListMemberDelete................................................................................ 47
GiftListMemberInsertUpdate.....................................................................47
GiftListSearch............................................................................................ 48
GiftListSkuDelete....................................................................................... 48
GiftListSkuDeleteByList............................................................................. 48
GiftListSkuGet........................................................................................... 48
GiftListSkuInsert........................................................................................ 49
GiftListSkuSetPurchased............................................................................49
GiftListV2Filters......................................................................................... 49
ImageInsertUpdate.................................................................................... 50
4
ImageListByStockKeepingUnitId................................................................50
ImageServiceCopyAllImagesFromSkuToSku...............................................50
ImageServiceInsertUpdate........................................................................50
IntegrationErrorCheckInstanceExists.........................................................50
IntegrationInterfaceGetAll.........................................................................51
IntegrationLog........................................................................................... 51
IntegrationLogError................................................................................... 51
IntegrationLogErrorInsertUpdate...............................................................51
IntegrationLogEvent.................................................................................. 51
NewsletterGet........................................................................................... 52
NewsletterGetAll....................................................................................... 52
NewsletterGetAllByDate............................................................................52
NewsletterGetPaged.................................................................................. 52
OrderAcknowledge.................................................................................... 53
OrderChangeStatus................................................................................... 53
OrderChangeStatusById............................................................................ 53
OrderChangeStatusV2............................................................................... 53
OrderChangeTrackingNumber...................................................................53
OrderChangeTrackingNumberV2...............................................................53
OrderDeliveryBlankRemoveByDTO............................................................54
OrderDeliveryChangeStatus......................................................................54
OrderDeliveryChangeStatusByManagementId..........................................54
OrderDeliveryChangeTrackingNumber......................................................54
OrderDeliveryInsertUpdate.......................................................................54
OrderDeliveryUpdateManagementId.........................................................55
OrderGet................................................................................................... 55
OrderGetByClient...................................................................................... 55
OrderGetByClientCpf................................................................................. 55
OrderGetByClientEmail............................................................................. 56
OrderGetByDeliveryId............................................................................... 56
OrderGetByManagementId........................................................................56
OrderGetByStatus..................................................................................... 56
OrderGetByStatusAndPaymentId..............................................................57
OrderGetByStatusByQuantity....................................................................57
OrderGetByStatusV2................................................................................. 57
5
OrderGetInteractions................................................................................. 57
OrderGetNewV2........................................................................................ 58
OrderGetNext50FromId............................................................................. 58
OrderGetNext50FromIdAndDate................................................................58
OrderGetNext50FromIdAndDateStatusChanged........................................58
OrderGetNext50FromIdV3.........................................................................59
OrderGetV2............................................................................................... 59
OrderGetV3............................................................................................... 59
OrderItemUpdateOrderDeliveryId.............................................................59
OrderPaymentGetAll.................................................................................. 60
OrderPayPalGetStatus............................................................................... 60
OrderStatusGetAll..................................................................................... 60
ProductActive............................................................................................ 60
ProductEspecificationInsert.......................................................................60
ProductEspecificationInsertByFieldId.........................................................61
ProductEspecificationInsertByList..............................................................61
ProductEspecificationInsertByListFieldIds..................................................61
ProductEspecificationListByProductId........................................................61
ProductEspecificationTextInsertByFieldId...................................................61
ProductGet................................................................................................ 62
ProductGetAllFromUpdateDateAndId.........................................................62
ProductGetByRefId.................................................................................... 62
ProductGetSimilarCategory.......................................................................62
ProductImageRemove............................................................................... 63
ProductInsertUpdate.................................................................................. 63
ProductSetSimilarCategory.......................................................................63
ProductSupplierGetCNPJ............................................................................ 63
ServiceGet................................................................................................. 64
ServiceInsertUpdate.................................................................................. 64
ServicePriceGet......................................................................................... 65
ServicePriceInsertUpdate..........................................................................65
ServicePriceList......................................................................................... 65
StockKeepingUnitActive............................................................................ 65
StockKeepingUnitComplementInsertUpdate..............................................66
StockKeepingUnitEspecificationInsert.......................................................66
6
StockKeepingUnitEspecificationInsertByFieldId.........................................66
StockKeepingUnitEspecificationInsertByList..............................................66
StockKeepingUnitEspecificationInsertByListFieldId....................................66
StockKeepingUnitEspecificationListBySkuId..............................................66
StockKeepingUnitGet................................................................................. 67
StockKeepingUnitGetAllByProduct.............................................................67
StockKeepingUnitGetAllFromUpdatedDate................................................67
StockKeepingUnitGetAllFromUpdatedDateAndId.......................................67
StockKeepingUnitGetByEan.......................................................................68
StockKeepingUnitGetByManufacturerCode...............................................68
StockKeepingUnitGetByRefId....................................................................68
StockKeepingUnitImageRemove................................................................68
StockKeepingUnitImageRemoveByName..................................................69
StockKeepingUnitInsertUpdate..................................................................69
StockKeepingUnitKitDeleteByParent..........................................................69
StockKeepingUnitKitInsertUpdate..............................................................70
StockKeepingUnitKitListByParent..............................................................70
StockKeepingUnitKitListBySkuId................................................................70
StockKeepingUnitPriceUpdate...................................................................71
StockKeepingUnitPriceUpdateByRefId.......................................................71
StockKeepingUnitServiceGet.....................................................................71
StockKeepingUnitServiceInsertUpdate......................................................71
StockKeepingUnitServiceList.....................................................................72
StoreGet.................................................................................................... 72
StoreList.................................................................................................... 72
UpdateNotifyShipping............................................................................... 72
WareHouseIStockableGetByStockKeepingUnit..........................................72
WareHouseIStockableGetByStockKeepingUnitV3......................................73
WareHouseIStockableUpdate....................................................................73
WareHouseIStockableUpdateV3................................................................73
ZipCodeGet............................................................................................... 73
Exemplos de integração na linguagem C#...................................................74
7
Classes
Campos e classes em vermelho não são preenchidos no checkout V3.
Campos e classes em marrom são preenchidos apenas no checkout V3.
AddressDTO
Propriedades
Id
Country
State
City
Street
Number
Tipos
int nulável
string
string
string
string
int nulável
Tamanho
50
2
100
150
-
Descrição
Id do endereço
País
Estado
Cidade
Rua
Número
8
More
Neighborhood
ZipCode
ReferencePoint
AddressType
string
string
string
string
string
100
100
10
max
100
UserGUID
AddressGUID
AddressNameV3
Guid nulável
Guid nulável
string
max
Propriedades
Id
Tipos
int nulável
Tamanho
-
ReceiverName
AddressName
string
string
200
200
Country
State
City
Street
Number
More
Neighborhood
ZipCode
ReferencePoint
Phone
CelPhone
OfficePhone
AddressType
string
string
string
string
int nulável
string
string
string
string
string
string
string
string
100
2
100
200
100
100
10
max
50
50
50
100
NumberV3
string
max
Complemento
Bairro
CEP
Ponto de referência
Tipo de endereço
(Comercial, Residencial,
etc.)
Id do usuário
Id do endereço
Tipo de endereço
(Comercial, Residencial,
etc.)
AddressOrderDTO
Descrição
Id do endereço da
compra
Nome do destinatário
Identificação do endereço
(Casa dos pais, Trabalho,
etc.)
País
Estado
Cidade
Rua
Número
Complemento
Bairro
CEP
Ponto de referência
Telefone
Telefone celular
Telefone comercial
Tipo de endereço
(Comercial, Residencial,
etc.)
Número podendo conter
letra
BrandDTO
Propriedades
Id
Name
Title
Description
Keywords
IsActive
AdWordsRemarketingCod
e
LomadeeCampaignCode
Tipos
int nulável
string
string
string
string
bool nulável
string
Tamanho
100
200
max
max
200
Descrição
Id da marca
Nome
Título
Descrição
Palavras chaves
Ativo
Código do AdWords
string
200
Código da campanha
do Lomadee
BuyTogetherBuyGainDTO
Propriedades
Id
Name
Tipos
int nulável
string
Tamanho
128
Descrição
Id do compre junto
Nome
9
Description
StartDate
string
DateTime nulável
512
-
EndDate
DateTime nulável
-
MinimumAmountSkuBenefit
int nulável
-
IsBenefitFreeShipping
bool nulável
-
IsActive
IdCollection
bool nulável
Int nulável
-
Descrição
Data de início da
promoção
Data de término da
promoção
Quantidade mínima
de skus para a
promoção ser
válida
Promoção possui
frete grátis
Ativo
Id da coleção que
pertence ao compre
junto
BuyTogetherDTO
Propriedades
Id
Name
Description
StartDate
Tipos
int nulável
string
string
DateTime nulável
Tamanho
128
512
-
EndDate
DateTime nulável
-
MinimumAmountSku
int nulável
-
DiscountFirstList
decimal nulável
-
DiscountSecondList
decimal nulável
-
IsActive
bool nulável
-
Descrição
Id do compre junto
Nome
Descrição
Data de início da
promoção
Data de término da
promoção
Quantidade
mínima de skus
para a promoção
ser válida
Desconto da
primeira lista
Desconto da
segunda lista
Ativo
BuyTogetherTakeXPayYDTO
Propriedades
Id
Name
Description
StartDate
Tipos
int nulável
string
string
DateTime nulável
Tamanho
128
512
-
EndDate
DateTime nulável
-
MinimumAmountSkuCondition
int nulável
-
IsActive
IdCollection
bool nulável
Int nulável
-
Descrição
Id do compre junto
Nome
Descrição
Data de início da
promoção
Data de término da
promoção
Quantidade
mínima de skus
para a promoção
ser válida
Ativo
Id da coleção que
pertence ao
compre junto
CategoryDTO
Propriedades
Id
Name
FatherCategoryId
Title
Tipos
int nulável
string
int nulável
string
Tamanho
100
150
Description
string
max
Descrição
Id da categoria
Nome
Id da categoria pai
Texto que será inserido
na tag TITLE do html
Descrição
10
Keywords
IsActive
AdWordsRemarketingCod
e
LomadeeCampaignCode
string
bool nulável
string
200
200
Palavras chaves
Ativo
Código do AdWords
string
200
Código da campanha
do Lomadee
Tamanho
100
max
-
Descrição
Id do grupo
Nome
Texto
Lista de cpfs
Lista de e-mails
ClientCandidateDTO
Propriedades
IdGroupClientCandidate
Name
Text
listCpf
listEmail
Tipos
int nulável
string
string
Lista de string
Lista de string
ClientDTO
Propriedades
Id
AddressClientId
FirstName
LastName
NickName
Email
Password
CpfCnpj
Phone
CelPhone
OfficePhone
DateBirth
CreateDate
LastLogonDate
Tipos
int nulável
int nulável
string
string
string
string
string
string
string
string
string
DateTime nulável
DateTime nulável
DateTime nulável
Tamanho
50
100
50
50
100
50
50
50
50
-
ChangeDate
DateTime nulável
-
IsActive
IsFraud
IsCorporate
UserGuid
CompanyName
CompanyNickName
Gender
IsNewsReceiver
IsSMSNewsReceiver
StateInscription
IsStateInscriptionImmune
bool nulável
bool nulável
bool nulável
Guid nulável
string
string
string
bool nulável
bool nulável
string
bool nulável
50
100
1
100
-
Age
RewardGiftCardId
int nulável
int nulável
-
Descrição
Id do cliente
Id do endereço
Primeiro nome
Sobrenome
Apelido
E-mail
Senha
CPF/CNPJ
Telefone
Telefone celular
Telefone comercial
Data de nascimento
Data de cadastro
Data do último acesso
(campo depreciado)
Data da última
alteração
Ativo
Fraude
Pessoa jurídica
Id do usuário
Razão social
Nome fantasia
Sexo
Recebe newsletter
Recebe SMS news
Inscrição estadual
Isento de inscrição
estadual
Idade
Vale vinculado ao
cliente para o uso do
Flex
ClientExtendedDTO
Propriedades
Client
ClientFields
Tipos
objeto ClientDTO
Lista de objetos
ClientFieldDTO
Tamanho
-
Descrição
Dados do cliente
Lista contendo os
dados de cadastro
estendido
11
ClientFieldDTO
Propriedades
Name
Tipos
string
Tamanho
100
FieldId
IsActive
IsRequired
FieldValueId
Value
FieldGroupId
FieldGroup
Int nulável
bool nulável
bool nulável
int nulável
string
int nulável
string
50
50
Tipos
int nulável
string
bool nulável
bool nulável
bool nulável
DateTime
DateTime
lista de int
Tamanho
100
-
Descrição
Nome do cadastro
estendido
Id do campo
Ativo
Obrigatório
Id do campo valor
Valor
Data término
Nome do grupo
CollectionDTO
Propriedades
Id
Name
ListInactiveProducts
Highlight
Searchable
FromDate
ToDate
ProductIdCollection
Descrição
Id da coleção
Nome
Lista produtos inativos
Realça
Buscável
Data início
Data término
Lista de produtos que
irão estar na coleção
DistributionCenterDTO
Propriedades
DistributionCenterID
Tipos
int nulável
Tamanho
-
Name
TaxID
HandlingTimeCost
Priority
string
string
int nulável
int nulável
50
14
-
Descrição
Id do centro de
distribuíção
Nome
Código fiscal
Tempo de manipulação
Prioridade
Tipos
int nulável
int nulável
int nulável
int nulável
int nulável
int nulável
int nulável
string
string
string
string
string
string
DateTime nulável
DateTime nulável
Tamanho
250
250
250
250
550
max
-
Descrição
Id do e-mail na fila
Id do cliente
Id do administrador
Id do fornecedor
Id do tipo de e-mail
Id do pedido
Id do sku
Nome do remetente
E-mail do remetente
Nome do destinatário
E-mail do destinatário
Assunto
Texto
Data de envio
Data de registro
Tipos
int nulável
int nulável
string
string
string
string
Tamanho
50
50
50
100
Descrição
Id do tipo de e-mail
Id do layout
Nome
Nome do remetente
E-mail do remetente
Assunto
EmailQueueDTO
Propriedades
EmailQueueId
ClientId
AdministratorId
SupplierId
EmailQueueTypeId
OrderId
StockKeepingUnitId
SenderName
SenderEmail
RecipientName
RecipientEmail
Subject
Text
SendingDate
RegisterDate
EmailQueueTypeDTO
Propriedades
EmailQueueTypeId
LayoutId
Name
SenderName
SenderEmail
Subject
12
Position
RecipientName
RecipientEmail
IsActive
int nulável
string
string
bool nulável
100
100
-
Posição
Nome do destinatário
E-mail do destinatário
Ativo
Tipos
string
int nulável
int nulável
bool nulável
bool nulável
int nulável
string
int nulável
string
bool nulável
Tamanho
100
100
-
Descrição
Nome do campo
Id da categoria
Id do campo
Ativo
Obrigatório
Id do tipo do campo
Nome do tipo do campo
Id do valor do campo
Descrição
É campo de sku
FieldDTO
Propriedades
Name
CategoryId
FieldId
IsActive
IsRequired
FieldTypeId
FieldTypeName
FieldValueId
Description
IsStockKeepingUnit
FreightDTO
((transportadora) Ex.: Sedex, e-Sedex, Total Express)
Propriedades
FreightID
DistributionCenterID
Tipos
int nulável
int nulável
Tamanho
-
ModalID
int nulável
-
FreightTypeID
int nulável
-
Name
string
50
Descrição
Id do frete
Id do centro de
distribuição
Id do modal (Pesado,
Leve, Refrigerado,
Químico) – Necessário
DePara
Id do tipo de frete
(Expresso, Econômico,
Normal) - Necessário
DePara
Nome do frete
FreightScheduledDateOptionDTO
Propriedades
StartDate
EndDate
AvailablePeriods
Tipos
DateTime
DateTime
array de string
Tamanho
-
Descrição
Data e hora inicial
Data e hora final
Períodos disponíveis
(Manhã, Tarde e Noite)
Tamanho
-
Descrição
Id do sku
Quantidade
FreightStockKeepingUnitContextDTO
Propriedades
StockKeepingUnitId
Quantity
Tipos
int
int
FreightStockKeepingUnitDTO
Propriedades
StockKeepingUnitId
Quantity
FreightPrice
DeliveryTime
FreightType
Tipos
int
int
decimal
int
string
Tamanho
(18,2)
max
Descrição
Id do sku
Quantidade
Preço do frete
Tempo de entrega
Tipo do frete (Sedex,
13
FreightTypeId
FreightScheduledDateOption
s
FreightAdditionalInfo
string
lista de objetos
FreightScheduledDateOptionDT
O
string
max
max
Normal etc)
Id do tipo do frete
Dados da entrega
agendada
Dados adicionais de
frete
FreightValueDTO
Propriedades
Id
FreightId
ZipCodeStart
ZipCodeEnd
WeightStart
WeightEnd
AbsoluteMoneyCost
PricePercent
PricePercentByWeight
Tipos
int nulável
int nulável
int nulável
int nulável
decimal nulável
decimal nulável
decimal nulável
decimal nulável
decimal nulável
Tamanho
(18,4)
(18,4)
(18,2)
(18,2)
(18,2)
ActiveStartDate
ActiveEndDate
MaxVolume
TimeCost
CubedWeight
DateTime nulável
DateTime nulável
decimal nulável
int nulável
decimal nulável
(18,4)
(18,4)
Propriedades
Id
Tipos
int nulável
Tamanho
-
RedeptionCode
MultipleRedemptions
MultipleCredits
RestrictedToOwner
EmissionDate
ExpiringDate
StatusId
OwnerId
Funds
string
bool nulável
bool nulável
bool nulável
DateTime nulável
DateTime nulável
short (Int16) nulável
string
decimal nulável
255
20
(18,2)
Descrição
Id do valor do frete
Id do frete
Código postal inicial
Código postal final
Peso inicial
Peso final
Valor absoluto
Porcentagem do preço
Porcentagem do preço
por peso
Data de ativação
Data de expiração
Volume máximo
Tempo
Peso cúbico
GiftCardDTO
Descrição
Id do GiftCard (este
campo é apenas para
consulta)
Código de resgate
Múltiplos resgates
Múltiplos créditos
Restrito ao dono
Data de emissão
Data de expiração
Id do status
CPF/CNPJ do usuário
Fundos (este campo é
apenas para consulta)
GiftCardTransactionItemDTO
Propriedades
RedemptionCode
Value
TransactionAction
Tipos
string
decimal nulável
enum TransactionAction
Tamanho
255
(18,2)
-
TransactionConfirmed
OrderId
StockKeepingUnitId
bool nulável
int nulável
int nulável
-
Descrição
Código de resgate
Valor
Ação da transação
(Credit, Debit)
Transação confirmada
Id da compra
Id do sku
GiftListDTO
Propriedades
GiftListId
ClientId
FileId
GiftListTypeId
Tipos
int nulável
int nulável
int nulável
int nulável
Tamanho
-
Descrição
Id da lista de presente
Id do cliente
Id do arquivo
Id do tipo da lista de
presente
14
ClientAddressId
int nulável
-
GiftCardId
Name
Gifted
Message
UrlFolder
DateCreated
EventDate
DateModified
IsActive
EventLocation
EventCity
EventState
IsPublic
Version
int nulável
string
string
string
string
DateTime nulável
DateTime nulável
DateTime nulável
bool nulável
string
string
string
bool nulável
int nulável
300
200
1000
100
300
200
2
-
GiftListMembers
Lista de
GiftListMemberDTO
-
Propriedades
GiftListMemberId
GiftListId
ClientId
Title
Name
Surname
Mail
Text1
Tipos
int nulável
int nulável
int nulável
string
string
string
string
string
Tamanho
100
100
100
100
200
Text2
string
200
IsAdmin
IsActive
bool nulável
bool nulável
-
Id do endereço do
cliente
Id do vale
Nome
Favorecido
Mensagem
Url da pasta
Data de criação
Data do evento
Data de alteração
Ativo
Local do evento
Cidade do evento
Estado do evento
Público
Versão da lista de
presente
Membros da lista de
presente.
GiftListMemberDTO
Descrição
Id da lista de casamento
Id do cliente
Título
Nome
Sobrenome
E=mail
Campo livre definido no
cadastro da lista
Campo livre definido no
cadastro da lista
Administrador
Ativo
GiftListStockKeepingUnitDTO
(Skus que pertencem a uma lista de presente)
Propriedades
GiftListSkuId
Tipos
int nulável
Tamanho
-
GiftListId
SkuId
OrderId
InsertedByClientId
ItemValue
FreightAndServicesValue
int nulável
int nulável
int nulável
int nulável
decimal nulável
decimal nulável
(18,2)
(18,2)
DateCreated
DatePurchased
_IsOrderFinished
OrderResponseMessage
DateTime nulável
DateTime nulável
bool nulável
string
1000
OrderMessage
OrderMessageFrom
string
string
1000
100
OrderMessageTo
string
100
WishedByClientId
int
-
Descrição
Id da lista de presente
sku
Id da lista de presente
Id do sku
Id do pedido
Id do cliente que inseriu
Valor do item
Valor do frete e
serviços
Data de criação
Data da compra
É pedido finalizado
Mensagem de resposta
do pedido
Mensagem do pedido
Remetente da
mensagem
Destinatário da
mensagem
Id do cliente que deseja
o sku
15
GiftListTypeDTO
Propriedades
GiftListTypeId
Name
Description
IsMessageAvailable
IsStockImpact
ShipToListOwner
DaysToExpireToVisitors
Tipos
int nulável
string
string
bool nulável
bool nulável
bool nulável
int nulável
Tamanho
200
500
-
DaysToExpireToMember
s
DaysToEventMin
int nulável
-
int nulável
-
DaysToEventMax
int nulável
-
MemberMin
int nulável
-
MemberMax
int nulável
-
MemberTitle
TextTitle1
string
string
500
100
TextTitle2
string
100
IsPublic
IsProtected
IsUnique
IsActive
Version
bool nulável
bool nulável
bool nulável
bool nulável
int nulável
-
Propriedades
Id
ArchiveFormatId
Tipos
int nulável
int nulável
Tamanho
-
ArchiveParentId
ArchiveTypeId
DateLastModified
int nulável
int nulável
DateTime nulável
-
Description
FileLocation
string
string
100
500
Height
HeightUnitMeasure
Name
Width
WidthUnitMeasure
StockKeepingUnitId
IsMain
Label
Tag
Url
int nulável
string
string
int nulável
string
int nulável
bool nulável
string
string
string
50
100
50
500
500
max
Descrição
Id do tipo de lista
Nome
Descrição
Mensagem disponível
Altera estoque
Enviar para o dono
Dias para expirar para
visitantes
Dias para expirar para
donos
Dias mínimos para o
evento
Dias máximos para o
evento
Quantidade de
membros mínima
Quantidade de
membros máxima
Título dos membros
Campo livre que ficará
definido para as listas
desse tipo
Campo livre que ficará
definido para as listas
desse tipo
Público
Protegido
Único
Ativo
Versão
ImageDTO
Descrição
Id da imagem
Id do formato do
arquivo
Id do arquivo pai
Id do tipo de arquivo
Data de última
alteração
Descrição
Localização do arquivo
no servidor
Altura
Unidade de medida
Nome
Largura
Unidade de medida
Id do sku
É principal
Label da imagem
Tag da imagem
Url da imagem
IntegrationInterfaceDTO
Propriedades
InterfaceName
Tipos
string
Tamanho
50
DateLastError
DateLastSuccess
InterfaceEnum
DateTime nulável
DateTime nulável
enum ErrorType
-
Descrição
Nome da interface
(chave)
Data do último erro
Data do último sucesso
Conversão do nome da
16
interface para enum
NewsletterDTO
Propriedades
Id
Name
Email
Data
IsPersisted
IsRemoved
Tipos
int nulável
string
string
DateTime nulável
bool nulável
bool nulável
Tamanho
100
100
-
Descrição
Id do newsletter
Nome
E-mail
Data
Persistido
Removido
OrderDeliveryDTO
Propriedades
Id
Tipos
int nulável
Tamanho
-
OrderId
OrderStatusId
int nulável
string
-
FreightId
InvoiceNumber
TrackingNumber
int nulável
string
string
50
max
DeliveryDate
DateExpectedDelivery
DateTime nulável
DateTime nulável
-
StausChangeDate
DateTime nulável
-
OrderStatus
OrderStatusDTO
-
OrderItems
lista de OrderItemDTO
-
ManagementId
int nulável
-
FreightTypeId
int nulável
-
StatusAdministratorId
int nulável
-
ScheduleDate
DateTime nulável
-
ScheduleShift
string
50
DaysForDistributionCenterProcessi
ng
int nulável
-
DaysForStockProcessing
int nulável
-
DaysForFreightDelivery
int nulável
-
DistributionCenter
DistributionCenterDTO
-
FreightName
string
-
Descrição
Id da compra
entrega
Id do pedido
Id da situação
(status)
Id do frete
Número da NF
Número de
rastreamento
Data de entrega
Data prevista de
entrega
Data de
alteração da
situação (status)
Situação
(status)
Itens da compra
entrega
Identificar do
pedido no
sistema ERP
(opcional)
Id do tipo de
frete (Expresso,
Econômico,
Normal) –
Necessário
DePara
Id do
administrador
que realizou a
última mudança
de status
Data de
agendamento
Mudança de
horário
Dias de
processamento
para o centro de
distribuíção
Dias de
processamento
para o estoque
Dias de entrega
do frete
Centro de
distribuíção
Nome do frete
17
FreightIdV3
string
max
Id do frete
OrderDiscountDTO
Propriedades
Id
OrderId
SkuId
DiscountId
Name
Tipos
int nulável
int nulável
int nulável
int nulável
string
Tamanho
max
Descrição
Id do desconto
Id do pedido
Id do sku
Id do desconto
Nome da promoção
OrderDTO
Propriedades
Id
ClientId
Media
Tipos
int nulável
int nulável
string
Tamanho
255
Source
string
255
Campaign
string
255
_Cost
PurchaseDate
PurchaseDateUtc
decimal nulável
DateTime nulável
DateTime nulável
(18,2)
-
TelemarketingId
int nulável
-
TelemarketingLogin
string
50
TelemarketingStoreLocatorNam
e
string
100
TelemarketingStoreLocatorCode
string
50
TelemarketingObservation
string
50
ClientIP
Keywords
string
string
50
255
IsGiftList
Coupon
Client
bool nulável
string
ClientDTO
50
-
Descrição
Id do pedido
Id do cliente
Identifica a mídia
que originou a
compra
(querystring
utm_media)
Identifica origem
da Compra
(querystring
utm_source)
Identifica a
campanha de
origem da compra
(querystring
utm_campaign)
Total do pedido
Data do pedido
Data do pedido
Utc
Id do usuário
televendas
Login do operador
de telemarketing
que realizou a
compra
Se o operador
estiver associado
a uma loja física,
exibe o nome da
loja
Se o operador
estiver associado
a uma loja física,
exibe o código da
loja
Dado
complementar ao
preenchido ao
entrar no modo
televendas (CPF
do vendedor,
observação...)
IP do cliente
Palavra chave que
originou a compra
(não é usada por
enquanto)
Lista de presente
Cupom
Cliente
18
Address
OrderAddressDTO
-
OrderDeliveries
lista de OrderDeliveryDTO
-
OrderPayments
lista de OrderPaymentDTO
-
GiftListStockKeepingUnits
lista de
GiftListStockKeepingUnitDTO
lista de OrderDiscountDTO
int
string
bool
decimal nulável
string
string
-
ListOrderDiscount
StoreId
StoreName
IsMultiStore
Tax
IdV3
AffiliateId
100
(18,2)
max
max
Endereço de
entrega
Um pedido pode
ser divido em uma
ou mais entregas
dependendo do
tipo do produto
(pesado, leve,
refrigerado,
quimico)
Ex.: Um pedido é
composto de uma
adega e um vinho.
A adega pode ser
enviada por uma
transportadora
diferente da do
vinho e também
com prazos
diferentes
Formas de
pagamento
Skus de uma lista
de presente
Lista de descontos
Id da loja
Nome da loja
É multiloja
Imposto
Id do pedido
Id do Marketplace
aonde o pedido foi
feito
OrderInteractionDTO
Propriedades
Id
OrderId
ClientId
Text
Date
StatusId
Tipos
int nulável
int
int nulável
string
Datetime
enum StatusIdEnum
Tamanho
-
Descrição
Id da interação
Id da compra
Id do cliente
Texto
Data da interação
Status (Pending,
InProgress e
Completed)
OrderInvoiceDTO
Propriedades
Courier
EmbeddedInvoice
Tipos
string
string
Tamanho
max
max
InvoiceNumber
string
max
InvoiceUrl
string
max
InvoiceValue
IssuanceDate
string
DateTime nulável
max
-
OrderId
int nulável
-
OrderIdV3
TrackingNumber
TrackingUrl
string
string
string
max
max
max
Descrição
Transportadora
Texto da
notafiscal
Número da
notafiscal
Url da notafiscal
eletrônica
Valor da notafiscal
Data da geração
da notafiscal
Id do pedido
(sequence)
Id do pedido
Código de rastreio
Url da
transportadora
19
StockKeepingUnits
array de objetos do tipo
OrderInvoiceStockKeepingUnitDT
O
-
para ratreio
Skus da notafiscal
OrderInvoiceStockKeepingUnitDTO
Propriedades
StockKeepingUnitId
Quantity
Price
Tipos
int nulável
int nulável
decimal nulável
Tamanho
(18,2)
Descrição
Id do sku
Quantidade
Preço da notafiscal
Tipos
string
decimal nulável
bool nulável
Tamanho
max
(18,2)
-
Descrição
Nome do desconto
Valor do desconto
É percentual
Propriedades
Id
ItemId
Tipos
int nulável
int nulável
Tamanho
-
ParentOrderItemId
int nulável
-
IsKit
RefId
bool nulável
string
50
OrderDeliveryId
int nulável
-
ShippingCost
ShippingCostOff
decimal nulável
decimal nulável
(18,2)
(18,2)
Cost
CostOff
decimal nulável
decimal nulável
(18,2)
(18,2)
GiftDiscountId
int nulável
-
BuyTogetherDiscountId
CupomValue
CupomValueOff
int nulável
decimal nulável
decimal nulável
(18,2)
(18,2)
IsStockImpact
bool nulável
-
Descrição
Id do item do pedido
Id do sku vendido.
Não existe campo
relativo à
quantidade, cada
item pode ter
serviços
específicos.
Id do item pai
(utilizado em caso
de kits)
Kit
Id de referência do
sku
Id da compra
entrega
Valor do frete
Valor do frete com
desconto
Preço
Preço com
desconto
Id do cupom de
desconto
Id do compre junto
Valor do cupom
Valor do item
subtraído do cupom
com desconto
Identifica se o item
já deu baixa no
estoque ou não
(true = ainda em
estoque)
OrderItemDiscountDTO
Propriedades
DiscountName
Value
IsPercentual
OrderItemDTO
20
StockLikelyId
int nulável
-
OrderItemServices
-
ProductId
ProductRefId
lista de
OrderItemServiceDTO
int nulável
int nulável
StockLikelyIdV3
MeasurementUnit
UnitMultiplier
string
string
decimal nulável
max
max
(18,2)
Discounts
lista de objetos do tipo
OrderItemDiscountDTO
decimal nulável
-
Id do estoque
provável do produto
Serviços do item
(sku)
Id do produto
Código de
referência do
produto
Id do estoque
Unidade de medida
Multiplicador da
unidade
Lista de descontos
(18,2)
Preço De
ListPrice
-
OrderItemServiceDTO
Propriedades
Id
Tipos
int nulável
Tamanho
-
OrderItemId
int nulável
-
StockKeepingUnitServiceId
int nulável
-
ArchiveId
int nulável
-
ListPrice
Price
decimal nulável
decimal nulável
(18,2)
(18,2)
GiftCardMessage
string
max
GiftCardFrom
string
100
GiftCardTo
string
100
StockKeepingUnitService
StockKeepingUnitServiceDTO
-
Descrição
Id do item de
serviço do
sku do pedido
Id do item no
pedido
Id do servico
do sku
Id do arquivo
(utilizado
para upload
de arquivo)
Preço De
Preço Por
(preço real)
Mensagem
do cartão de
presente
Remetente
cartão de
presente
Destinatário
cartão de
presente
Serviços do
sku
OrderPaymentDTO
Propriedades
Id
Tipos
int nulável
Tamanho
-
OrderId
OrderPaymentStatusId
int nulável
int nulável
-
PaymentId
int nulável
-
GiftCardId
CardNumber
CardSecurityCode
int nulável
string
string
500
300
Plots
int nulável
-
CostWithInterest
Interest
CardName
CardLast4Numbers
decimal nulável
decimal nulável
string
string
(18,2)
(18,2)
50
50
Descrição
Id da forma de
pagamento do pedido
Id do pedido
Situação do
pagamento (status)
Id da forma de
pagamento
Id do vale presente
Número do cartão
Código de segurança
do cartão
Quantidade de
parcelas
Valor com juros
Juros
Titular do cartão
Últimos 4 digitos
21
CardFirst6Numbers
CardYear
CardMonth
IsValid
Date
Street
City
State
Number
ZipCode
Neighborhood
Country
ReferencePoint
AddressType
Complement
Url
string
string
string
bool nulável
DateTime nulável
string
string
string
int nulável
string
string
string
string
string
string
string
50
300
300
150
100
2
50
100
50
max
100
100
400
GiftCardRedemptionCode
string
255
PaymentTransactionId
string
50
PaymentAuthorizationId
string
100
InstallmentValue
PaymentUniqueSerialNumber
decimal
string
(18,2)
string
Primeiros 6 digitos
Ano de vencimento
Mês de vencimento
Válido
Data do pedido
Rua
Cidade
Estado
Número
CEP
Bairro
Pais
Ponto de referência
Tipo de endereço
Complemento
Url do boleto ou do
ambiente para débito
On-Line
Código de resgate do
vale presente
Id da transação do
pagamento. Em
casos de compra
com boleto este
campo informar-se-á
o número do
documento. Em
casos de compra
com cartão este
campo informar-se-á
o identificador único
da transação
Id da autorização do
pagamento ou código
do boleto. Em casos
de compra com
boleto este campo
informar-se-á o
número do código de
barras. Em casos de
compra com cartão
este campo
informar-se-á o
número da sequência
da autorização
Valor da parcela
NSU
OrderStatusDTO
Propriedades
Id
Tipos
string
Tamanho
10
Description
string
100
Propriedades
Id
Tipos
int
Tamanho
-
Name
string
50
IsActive
Type
bool nulável
string
50
Descrição
Id do status
(CAP,ERP,etc)
Nome do status
PaymentDTO
Descrição
Id da forma de
pagamento
Nome da forma de
pagamento
Ativo
Tipo (Boleto,
22
Crédito, etc)
ProductDTO
Propriedades
Id
Name
DepartmentId
CategoryId
Tipos
int nulável
string
int nulável
int nulável
Tamanho
150
-
BrandId
LinkId
int nulável
string
255
RefId
IsVisible
Description
DescriptionShort
string
bool nulável
string
string
200
max
max
ReleaseDate
KeyWords
Title
DateTime nulável
string
string
max
150
IsActive
bool nulável
-
TaxCode
MetaTagDescription
SupplierId
ShowWithoutStock
ListStoreId
string
string
int nulável
bool
lista de int
50
max
-
AdWordsRemarketingCode
LomadeeCampaignCode
string
string
200
200
Tipos
int
int
lista de string
Tamanho
max
Descrição
Id do produto
Nome do produto
Id do departamento
Id da categoria. Caso
possua sku e não
seja preenchido,
desativar-se-á os
skus referentes a
este produto e o
próprio produto.
Id da marca
Url do produto (sem
espaços e sem
caracteres especiais)
Código de referência
Visível
Descrição
Descrição resumida
(vitrine)
Data de lançamento
Palavras-chaves
Texto que será
inserido na tag TITLE
do html
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.
Código fiscal
MetaTagDescription
Id do fornecedor
Exibe sem estoque
Lista com os ids das
lojas em que o
produto pode ser
exibido (multiloja)
Código do AdWords
Código da campanha
do Lomadee
ProductFieldIdDTO
Propriedades
productid
fieldId
fieldValues
Descrição
Id do produto
Id do campo
Valor(es) do campo
23
ProductFieldNameDTO
Propriedades
productid
fieldId
fieldValues
Tipos
int
fieldName
lista de string
Tamanho
100
max
Descrição
Id do produto
Nome do campo
Valor(es) do campo
Propriedades
Id
Name
IsActive
IsVisibleOnProduct
Tipos
int nulável
string
bool nulável
bool nulável
Tamanho
100
-
IsVisibleOnCart
IsVisibleOnService
bool nulável
bool nulável
-
IsFile
bool nulável
-
IsGiftCard
IsRequired
bool nulável
bool nulável
-
Descrição
Id do serviço
Nome
Ativo
Visível nos
produtos
Visível no carrinho
Visível na tela de
serviços
Arquivo
(possibilidade de
upload no
checkout)
Vale presente
É obrigatório
ServiceDTO
ServicePriceDTO
Propriedades
Id
Tipos
int nulável
Tamanho
-
ServiceId
Name
ListPrice
Price
int nulável
string
decimal nulável
decimal nulável
100
(18,2)
(18,2)
Service
ServiceDTO
-
Descrição
Id do preço de
serviço
Id do serviço
Nome
Preço De
Preço Por (preço
normal)
Serviço
StockKeepingUnitComplementDTO
Propriedades
StockKeepingUnitId
StockKeepingUnitComplement
s
Tipos
int
lista de int
Tamanho
-
ComplementType
enum
-
Descrição
Id do sku
Todos os ids de
skus que são
complementos de
um determinado
tipo
Tipo do
complemento
(Acessório,
sugestão ou
similar)
StockKeepingUnitDTO
Propriedades
Id
ProductId
IsActive
Tipos
int nulável
int nulável
bool nulável
Tamanho
-
Descrição
Id do sku
Id do produto
O campo isActive define
se o sku está ativo ou
24
Name
RefId
CostPrice
ListPrice
Price
string
string
decimal nulável
decimal nulável
decimal nulável
200
50
(18,2)
(18,2)
(18,2)
Height
Length
Width
WeightKg
RealHeight
RealLength
RealWidth
RealWeightKg
ModalId
decimal nulável
decimal nulável
decimal nulável
decimal nulável
decimal nulável
decimal nulável
decimal nulável
decimal nulável
int nulável
(18,4)
(18,4)
(18,4)
(18,4)
(18,4)
(18,4)
(18,4)
(18,4)
-
CubicWeight
InternalNote
decimal nulável
string
(18,4)
max
IsKit
bool nulável
-
ProductName
IsAvaiable
StockKeepingUnitEans
string
bool nulável
lista de
StockKeepingUnitEanDTO
150
-
DateUpdated
RewardValue
EstimatedDateArrival
ManufacturerCode
ComercialConditionId
MeasurementUnit
UnitMultiplier
DateTime nulável
decimal nulável
DateTime nulável
string
int nulável
string
decimal nulável
(18,2)
100
-
inativo. É necessário
utilizar o método
"StockKeepingUnitActivat
e" para ativar um sku.
Caso seja preenchido
como false, o sku será
desativado.
Nome do sku
Código de referência
Preço de custo*
Preço De*
Preço Por (preço normal)
*
Altura*
Comprimento*
Largura*
Peso em grama(g)*
Altura real*
Comprimento real*
Largura real*
Peso em grama(g) real*
Refere-se à modalidade
de frete
(1- leve,
2- pesado,
3-refrigerado,
4-químico)
Peso cúbico
Este campo não é mais
utilizado no sistema
embora ainda exista
(depreciado)
Sku é do tipo kit (uma vez
kit, o sku não poderá
deixar de ser kit)
Nome do produto
Disponível (depreciado)
Código de barras
(EAN13). Caso um sku
estiver ativo, o RefId
estiver vazio e o ean não
for preenchido
inativar-se-á o sku
Data de atualização
Código de fidelidade
Data de pré-venda
Código do fabricante
Id da condição comercial
Unidade de medida
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
Ean
Tipos
String
Tamanho
50
Descrição
Código de barras
(único). Esta
informação é
meramente
informativa e não é
25
obrigatória*.
*Para que um sku seja ativado é necessário que ele tenha código de
referência ou EAN.
StockKeepingUnitFieldIdDTO
Propriedades
idSku
fieldId
fieldValues
Tipos
int
int
lista de string
Tamanho
max
Descrição
Id do sku
Id do campo
Valor(es) do campo
Tamanho
100
max
Descrição
Id do sku
Nome do campo
Valor(es) do campo
StockKeepingUnitFieldNameDTO
Propriedades
idSku
fieldId
fieldValues
Tipos
int
fieldName
lista de string
StockKeepingUnitKitDTO
Propriedades
Id
StockKeepingUnitParent
StockKeepingUnitId
Amount
UnitPrice
Tipos
int nulável
int nulável
int nulável
int nulável
decimal nulável
Tamanho
(18,2)
Descrição
Id do kit
Id do sku pai
Id do sku
Quantidade de itens
Preço unitário
StockKeepingUnitQuantityDTO
Propriedades
StockKeepingUnitId
StockKeepingUnitComplement
s
Tipos
int
lista de int
Tamanho
-
ComplementType
enum
-
Descrição
Id do sku
Todos os ids de
skus que são
complementos de
um determinado
tipo
Tipo do
complemento
(Acessório,
sugestão ou
similar)
StockKeepingUnitServiceDTO
Propriedades
Id
ServiceId
Tipos
int nulável
int nulável
Tamanho
-
ServicePriceId
int nulável
-
StockKeepingUnitId
Name
Description
IsActive
ServicePrice
int nulável
string
string
bool nulável
ServicePriceDTO
50
100
-
Descrição
Id do serviço do sku
Id do serviço. Ex.:
Garantia Estendida,
Montagem
Id do preço do
serviço
Id do sku
Nome do serviço
Descrição
Ativo
Preço do serviço
26
StoreDTO
Propriedades
Id
Name
IsAtive
Tipos
int nulável
string
bool nulável
Tamanho
-
Descrição
Id da loja
Id da loja
Ativo
Tipos
int nulável
int nulável
int nulável
int nulável
int nulável
string
string
Tamanho
-
Descrição
Id do estoque
Id do sku
Estoque disponível
Estoque reservado
Estoque total
Id do estoque
Nome do estoque
Propriedades
City
Neighborhood
State
StateFullName
Tipos
string
string
string
string
Tamanho
100
100
2
100
Street
Value
string
string
150
10
WareHouseIStockableDTO
Propriedades
WareHouseId
StockKeepingUnitId
AvailableQuantity
ReservedQuantity
TotalQuantity
WareHouseIdV3
WareHouseName
max
max
ZipCodeDTO
Descrição
Cidade
Bairro
Estado
Nome completo do
estado
Rua
CEP
27
Métodos
Métodos em vermelho não são utilizados no checkout V3.
Métodos em marrom são utilizados apenas no checkout V3.
AddressByAddressClient
Obter as informações sobre um determinado endereço de um cliente.
Parâmetros de entrada
Tipo
addressClientId
int
Parâmetros de saída
Tipo
objeto
AddressDTO
AddressGetByClientId
Obter todos os endereços de um dado cliente.
Parâmetros de entrada
Tipo
clientId
int
Parâmetros de saída
Tipo
Lista de objetos
AddressDTO
AddressGetByClientIdV3
Obter todos os endereços de um dado cliente.
Parâmetros de entrada
Tipo
clientIdV3
string
28
Parâmetros de saída
Tipo
Lista de objetos
AddressDTO
AddressInsertByClientId
Inserir um novo endereço para um determinado cliente pelo seu id.
Parâmetros de entrada
Tipo
ClientId
ClientAddress
int
AddressDTO
Parâmetros de saída
Tipo
objeto
AddressDTO
AddressInsertByCpfCnpj
Inserir um novo endereço para um determinado cliente pelo seu CpfCnpj.
Parâmetros de entrada
Tipo
CpfCnpj
ClientAddress
string
AddressDTO
Parâmetros de saída
Tipo
objeto
AddressDTO
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.
29
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
firstListStockKeepingUnit
secondListStockKeepingUnit
int
Lista de int
Lista de int
30
BuyTogethertakeXPayYInsertUpdate
Insere/Altera um compre junto do tipo pegue x e pague y.
Parâmetros de entrada
Tipo
objBuyTogetherTakeXPayYDTO
BuyTogetherTakeXPayYDTO
Parâmetros de saída
Tipo
objeto
BuyTogetherTakeXPayYDTO
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.
ClientCandidateDeleteByCpfOrEmail
Apagar as informações de um cliente candidadto por cpf ou e-mail.
Parâmetros de entrada
Tipo
ClienteCandidato
ClientCandidateDTO
31
ClientCandidateDeleteById
Apagar as informações de um cliente candidato pelo id do grupo.
Parâmetros de entrada
Tipo
idClientCandidate
int
ClientCandidateGet
Busca as informações de um determinado cliente candidato pelo id do grupo.
Parâmetros de entrada
Tipo
idClusterGrupoClienteCandidato
int
Parâmetros de saída
Tipo
objeto
ClientCandidateDTO
ClientCandidateInsert
Inserir informações sobre um cliente candidato.
Parâmetros de entrada
Tipo
ClienteCandidato
ClientCandidateDTO
Parâmetros de saída
Tipo
objeto
ClientCandidateDTO
ClientGet
Obter as informações sobre um determinado cliente.
Parâmetros de entrada
Tipo
idClient
int
Parâmetros de saída
Tipo
objeto
ClientDTO
ClientGetAllFromCreatedDateAndId
Busca todos os clientes através da data de cadastro e do identificador do cliente.
Parâmetros de entrada
Tipo
dateCreated
startingClientId
topRows
DateTime
int nulável
int
Parâmetros de saída
Tipo
Lista de objetos
ClientDTO
ClientGetByCPF
Obter as informações sobre um determinado cliente com um determinado CPF/CNPJ.
Parâmetros de entrada
Tipo
32
CpfCnpj
string
Parâmetros de saída
Tipo
objeto
ClientDTO
ClientGetByEmail
Obter as informações sobre um determinado cliente com um determinado e-mail.
Parâmetros de entrada
Tipo
Email
string
Parâmetros de saída
Tipo
objeto
ClientDTO
ClientGetByEmailV3
Obter as informações sobre um determinado cliente com um determinado e-mail.
Parâmetros de entrada
Tipo
Email
string
Parâmetros de saída
Tipo
objeto
ClientDTO
ClientGetByGuid
Obter as informações sobre um determinado cliente com um determinado guid.
Parâmetros de entrada
Tipo
guid
string
Parâmetros de saída
Tipo
objeto
ClientDTO
ClientGetExtendedInfo
Obter as informações de cadastro estendido de um dado cliente.
Parâmetros de entrada
Tipo
clientId
int
Parâmetros de saída
Tipo
objeto
ClientExtendedDTO
ClientGetExtendedInfoByCPF
Obter as informações de cadastro estendido por um dado CpfCnpj.
Parâmetros de entrada
Tipo
CpfCnpj
string
33
Parâmetros de saída
Tipo
objeto
ClientExtendedDTO
ClientGetV3
Obter as informações sobre um determinado cliente.
Parâmetros de entrada
Tipo
idClient
string
Parâmetros de saída
Tipo
objeto
ClientDTO
ClientInsertUpdate
Inserir ou atualizar os dados de um cliente.
Parâmetros de entrada
Tipo
cliente
address
ClientDTO
AddressDTO
Dados obrigatórios (ClientDTO)
Tipo
Name
NickName
CpfCnpj
Email
Password
CreateDate
IsActive
IsCorporate,
IsFraud
IsNewsReceiver
IsSMSNewsReceiver
string
string
string
string
string
DateTime
bool
bool
bool
bool
bool
Dados obrigatórios (AddressDTO)
Tipo
ZipCode
string
ClientRewardGet
Obter as informações o valor de fidelidade de um dado cliente.
Parâmetros de entrada
Tipo
clientId
int
Parâmetros de saída
Tipo
Valor
decimal
ClientRewardGetByCPF
Obter as informações o valor de fidelidade de um dado cliente pelo seu CPF/CNPJ.
34
Parâmetros de entrada
Tipo
cpfCnpj
string
Parâmetros de saída
Tipo
Valor
decimal
ClientRewardUpdate
Debitar ou creditar um valor de fidelidade de um dado cliente.
Parâmetros de entrada
Tipo
clientId
totalReward
transactionAction
int
decimal
enum TransactionAction
ClientRewardUpdateByCPF
Debitar ou creditar um valor de fidelidade de um dado cliente pelo seu CPF/CNPJ.
Parâmetros de entrada
Tipo
cpfCnpj
totalReward
transactionAction
string
decimal
enum TransactionAction
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
CollectionInsertUpdate
Obter as informações sobre uma determinada coleção.
Parâmetros de entrada
Tipo
collection
CollectionDTO
Parâmetros de saída
Tipo
objeto
CollectionDTO
Dados obrigatórios (CollectionDTO)
Tipo
Name
FromDate
ToDate
ProductIdCollection
string
DateTime
DateTime
lista de int
DistributionCenterGet
Obter as informações sobre um determinado centro de distribuição.
35
Parâmetros de entrada
Tipo
idDistributionCenter
int
Parâmetros de saída
Tipo
objeto
DistributionCenterDTO
DistributionCenterGetByTaxId
Obter as informações sobre um determinado centro de distribuição a partir do taxId.
Parâmetros de entrada
Tipo
taxID
string
Parâmetros de saída
Tipo
objeto
DistributionCenterDTO
EmailQueueConfirmSending
Confirmar o envio de um dado e-mail.
Parâmetros de entrada
Tipo
EmailQueueId
int
Parâmetros de saída
Tipo
SendingDate
Datetime
EmailQueueGetAllBetweenTimeIntervalAndEmailTypeId
Obter lista de e-mails não enviados de um determinado tipo e por intervalo de datas.
Parâmetros de entrada
Tipo
initialTime
finalTime
initialId
topRows
emailTypeId
DateTime
DateTime
int nulável
int
int nulável
Parâmetros de saída
Tipo
lista de objetos
EmailQueueDTO
EmailQueueNotSendedByType
Obter lista de e-mails não enviados de um determinado tipo.
Parâmetros de entrada
Tipo
EmailQueueTypeId
int
Parâmetros de saída
Tipo
lista de objetos
EmailQueueDTO
36
FreightCalculate
Obtém o custo do frete mais barato para um dado sku.
Parâmetros de entrada
Tipo
skuId
zipCode
distributionCenterId
freightTypeId
int
string
int
int
Parâmetros de saída
Tipo
objeto
FreightValueDTO
FreightCalculateV3
Obtém o custo do frete para um grupo de skus.
Parâmetros de entrada
Tipo
freightSkuContext
zipCode
lista de objetos do tipo
FreightStockKeepingUnitContextDTO
string
Parâmetros de saída
Tipo
lista de objetos
FreightStockKeepingUnitDTO
FreightGet
Obter as informações sobre um determinado frete.
Parâmetros de entrada
Tipo
idFreight
int
Parâmetros de saída
Tipo
objeto
FreightDTO
FreightGetAll
Obter todos os fretes.
Parâmetros de saída
Tipo
lista de objetos
FreightDTO
FreightInsertUpdate
Inserir ou atualizar os dados de um frete.
Parâmetros de entrada
Tipo
freight
FreightDTO
Parâmetros de saída
Tipo
objeto
FreightDTO
37
Dados obrigatórios (FreightDTO)
Tipo
FreightID*
int
FreightTypeID
int
ModalID
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.
FreightValueDeleteByFreight
Remover o(s) valor(es) de um frete a partir do id de frete.
Parâmetros de entrada
Tipo
idFreight
int
FreightValueInsertUpdate
Inserir ou atualizar os dados de um valor de frete.
Parâmetros de entrada
Tipo
freightValue
FreightValueDTO
Parâmetros de saída
Tipo
objeto
FreightValueDTO
Dados obrigatórios (FreightValueDTO)
Tipo
FeightId
ZipCodeEnd
ZipCodeStart
WeightEnd
WeightStart
AbsoluteMoneyCost
PricePercent
PricePercentByWeight
int
int
int
decimal
decimal
decimal
decimal
decimal
FreightValueInsertUpdateByList
Inserir ou atualizar os dados dos valores de fretes a partir de uma lista.
Parâmetros de entrada
Tipo
lstFreightValue
FreightValueDTO
OBS.: Os objetos “FreightValueDTO” da lista devem ser preenchidos de acordo com a especificação do
método "FreightValueInsertUpdate".
GiftCardGet
Obter as informações sobre um determinado gift card.
Parâmetros de entrada
Tipo
Id
int
38
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
OwnerId
EmissionDate
ExpiringDate
int
string
DateTime
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
Value
TransactionAction
TransactionConfirmed
string
decimal
enum TransactionAction
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
39
StockKeepingUnitId
Quantity
IsActive
int
int
bool
Parâmetros de saída
Success
Tipo
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
eventDateEnd
startingGiftListId
topRows
DateTime
Datetime
int nulável
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
startingGiftListId
topRows
Datetime
int nulável
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
startingGiftListId
topRows
Datetime
int nulável
int
40
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.
41
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
GiftListTypeId
ClientAddressId
Gifted
UrlFolder
EventDate
DataCreateDT
GiftListMembers**
int
int
int
string
string
DateTime
DateTime
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
GiftListId
int
int
GiftListMemberInsertUpdate
Inserir um membro em uma lista.
Parâmetros de entrada
Tipo
giftListMember
lista de objetos GiftListMemberDTO
Dados obrigatórios (GiftListDTO)
Tipo
GiftListId
Nome
Sobrenome
isAdmin
isActive
ClientId*
int
int
int
string
string
int
42
*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
eventLocation
eventCity
eventDate
string
string
string
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
skuId
Quantity
int
int
int
GiftListSkuDeleteByList
Remover uma coleção de skus de uma lista.
Parâmetros de entrada
Tipo
giftListId
skuQuantity
int
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
43
giftListSku
GiftListStockKeepingUnitDTO
Parâmetros de saída
Tipo
objeto
GiftListStockKeepingUnitDTO
Dados obrigatórios (GiftListStockKeepingUnitDTO)
Tipo
GiftListId
SkuId
InsertedByClientId
WishedByClientId*
int
int
int
int
GiftListSkuSetPurchased
Definir um sku da lista como "comprado".
Parâmetros de entrada
Tipo
giftListId
skuId
Quantity
orderId
int
int
int
int
GiftListV2Filters
Obter uma lista de gift list dado uma consulta.
Parâmetros de entrada
Tipo
giftListTypeId
giftListId
clientId
eventDateSince
eventDateUntil
isActive
int nulável
int nulável
int nulável
DateTime nulável
DateTime nulável
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
ArchiveTypeId
int
int nulável
44
ImageServiceCopyAllImagesFromSkuToSku
Copia todas as imagens de um sku origem para outro sku destino.
Parâmetros de entrada
Tipo
stockKeepingUnitIdFrom
stockKeepingUnitIdTo
int
int
ImageServiceInsertUpdate
Inserir uma imagem relacionada a um sku.
Parâmetros de entrada
Tipo
urlImage
imageName
stockKeepingUnitId
fileId
string
string
int
int nulável
IntegrationErrorCheckInstanceExists
Busca se um dado tipo de erro e id (instância) já existe logado.
Parâmetros de saída
Tipo
errorType
instance
enum ErrorType
String
IntegrationInterfaceGetAll
Obter todas as as interfaces disponíveis para integração e suas datas de sucesso e falha.
Parâmetros de saída
Tipo
lista de objetos
IntegrationInterfaceDTO
IntegrationLog
Inserir o tipo de erro.
Parâmetros de entrada
Tipo
errorType
enum ErrorType
IntegrationLogError
Inserir o tipo de erro e o erro.
Parâmetros de entrada
Tipo
errorType
error
enum ErrorType
string
IntegrationLogErrorInsertUpdate
Inserir um log de erro que poderá ser usado no método IntegrationErrorCheckInstanceExists
para averiguar se um erro já foi lado para um dado registro.
Parâmetros de entrada
Tipo
errorType
instance
error
enum ErrorType
string
string
45
errorDetail
string
IntegrationLogEvent
Inserir um evento (ex.: sucesso na integração de um pedido vinculando a ele o id do pedido).
Parâmetros de entrada
Tipo
errorType
message
orderId
enum ErrorType
string
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
EndDate
DateTime
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
quantity
int
int
Parâmetros de saída
Tipo
Lista de objetos
NewsletterDTO
46
OrderAcknowledge
Altera o status do pedido para Sent – integrado (CheckoutV2). Este método está descontinuado
e será removido. Utilizar o método OrderChangeStatusV2. (Método depreciado)
Parâmetros de entrada
Tipo
idOrder
int
OrderChangeStatus
Alterar as informações de status de uma determinada compra.
Parâmetros de entrada
Tipo
idOrder
statusOrder
int
string
OrderChangeStatusById
Alterar o status de uma entrega a partir do id da entrega e o status.
Parâmetros de entrada
Tipo
idOrderDelivery
statusOrder
int
string
OrderChangeStatusV2
Alterar as informações de status de uma determinada compra (CheckoutV2).
Parâmetros de entrada
Tipo
orderId
integrationStatus
int
enum IntegrationStatus
OrderChangeTrackingNumber
Alterar o tracking number (código de rastreio) a partir do id da compra.
Parâmetros de entrada
Tipo
idOrder
trackingNumber
int
string
OrderChangeTrackingNumberV2
Alterar o tracking number (código de rastreio) a partir do id da compra (CheckoutV2).
Parâmetros de entrada
Tipo
idOrder
trackingNumber
int
string
OrderDeliveryBlankRemoveByDTO
Remover uma compra entrega a partir de um objeto OrderDTO.
47
Parâmetros de entrada
Tipo
objeto
OrderDTO
OrderDeliveryChangeStatus
Alterar o status de uma compra entrega. Deve ser usado em casos de entregas parciais, onde
o pedido é quebrado no ERP em várias entregas. Via integração o ERP força a quebra de
entregas do do pedido do lado do site também, separando o pedido em entrega de produtos
enviados e entregas de produtos pendentes.
Parâmetros de entrada
Tipo
orderId
statusOrder
ManagementId
AdministratorId
items
int
string
int
int
lista de objetos OrderItem
OrderDeliveryChangeStatusByManagementId
Alterar o status de uma compra entrega a partir do id de gerenciamento.
Parâmetros de entrada
Tipo
statusOrder
ManagementId
string
int
OrderDeliveryChangeTrackingNumber
Alterar o status de uma compra entrega a partir do número de rastreamento.
Parâmetros de entrada
Tipo
idOrderDelivery
trackingNumber
int
string
OrderDeliveryInsertUpdate
Inserir ou alterar uma compra entrega.
Parâmetros de entrada
Tipo
orderDeliveryDTO
OrderDeliveryDTO
Parâmetros de saída
Tipo
objeto
OrderDeliveryDTO
Dados obrigatórios (OrderDeliveryDTO)
Tipo
Id
OrderId
OrderStatusId
StatusChangeDate
StatusAdministratorId
int
int
string
DateTime
int
OrderDeliveryUpdateManagementId
Alterar uma compra entrega a partir do id de gerenciamento.
Parâmetros de entrada
Tipo
48
order
ManagementId
OrderDTO
int
OrderGet
Obter as informações sobre uma determinada compra.
Parâmetros de entrada
Tipo
OrderId
int
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderGetByClient
Obter todas as compras de um dado cliente pelo seu id.
Parâmetros de entrada
Tipo
clientId
int
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderGetByClientCpf
Obter todas as compras de um dado cliente pelo seu Cpf/Cnpj.
Parâmetros de entrada
Tipo
cpfCnpj
string
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderGetByClientEmail
Obter todas as compras de um dado cliente pelo seu e-mail.
Parâmetros de entrada
Tipo
orderDeliveryId
int
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderGetByDeliveryId
Obter a informação de uma compra que tenha o id de compra entrega informado.
Parâmetros de entrada
Tipo
orderDeliveryId
int
Parâmetros de saída
Tipo
49
objeto
OrderDTO
OrderGetByManagementId
Obter a informação de uma compra que tenha o GerencialId informado.
Parâmetros de entrada
Tipo
managementId
int
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderGetByStatus
Obter as informações sobre conjunto de compras que estejam com o status solicitado.
Parâmetros de entrada
Tipo
statusOrder
string
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetByStatusAndPaymentId
Obter as informações sobre conjunto de compras que estejam com o status solicitado e com as
formas de pagamento solicitadas.
Parâmetros de entrada
Tipo
statusOrder
paymentIds
string
Lista de int
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetByStatusByQuantity
Obter as informações sobre conjunto de compras que estejam com o status solicitado limitando
a quantidade de compras que irá ser retornada.
Parâmetros de entrada
Tipo
statusOrder
quantity
string
int
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetByStatusV2
Obter as informações sobre conjunto de compras que estejam com o status solicitado
(CheckoutV2).
Parâmetros de entrada
Tipo
50
integrationStatus
enum IntegrationStatus
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetInteractions
Obter as interações de um dado pedido.
Parâmetros de entrada
Tipo
orderId
int
Parâmetros de saída
Tipo
lista de objetos
OrderInteractionDTO
OrderGetNewV2
Obter as informações sobre conjunto de compras que estejam com o status Available
(CheckoutV2). Este método está descontinuado e será removido. Utilizar o método
OrderGetByStatusV2. (Método depreciado)
Parâmetros de entrada
Tipo
OrderId
int
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetNext50FromId
Obter as informações das 50 compras seguintes a um dado id.
Parâmetros de entrada
Tipo
orderId
int
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetNext50FromIdAndDate
Obter as informações das 50 compras seguintes a um dado id e data de compra.
Parâmetros de entrada
Tipo
orderId
lastDate
int
DateTime
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
51
OrderGetNext50FromIdAndDateStatusChanged
Obter as informações das 50 compras seguintes a um dado id e data de atualização de status.
Parâmetros de entrada
Tipo
orderId
lastDate
int
DateTime
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetNext50FromIdV3
Obter as informações das 50 compras seguintes a um dado id.
Parâmetros de entrada
Tipo
sequence
int
Parâmetros de saída
Tipo
lista de objetos
OrderDTO
OrderGetV2
Obter as informações sobre uma determinada compra (CheckoutV2).
Parâmetros de entrada
Tipo
OrderId
int
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderGetV3
Obter as informações sobre uma determinada compra (CheckoutV3).
Parâmetros de entrada
Tipo
idClient
string
Parâmetros de saída
Tipo
objeto
OrderDTO
OrderItemUpdateOrderDeliveryId
Alterar o id de compra entrega de um item da compra.
Parâmetros de entrada
Tipo
orderItemDTO
OrderItemDTO
52
OrderPaymentGetAll
Lista todos os pagamentos existentes na VTEX.
Parâmetros de saída
Tipo
Lista de objetos
PaymentDTO
OrderPayPalGetStatus
Verifica o status de um pedido feito utilizando a forma de pagamento PayPal.
Parâmetros de entrada
Tipo
OrderId
TransactionId
int
string
Parâmetros de saída
Tipo
status
string
OrderStatusGetAll
Recuperar todos os status possíveis para uma compra.
Parâmetros de saída
Tipo
lista de objetos
OrderStatusDTO
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
fieldName
fieldValues
int
string
lista de string
ProductEspecificationInsertByFieldId
Inserir uma especificação para um produto a partir do id do campo.
Parâmetros de entrada
Tipo
idProduct
fieldId
fieldValues
int
int
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.
53
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
ProductId
topRows
DateTime
int
int
Parâmetros de saída
Tipo
objeto
ProductDTO
54
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
55
categoryId
int
ProductSupplierGetCNPJ
Obter o CNPJ do fornecedor de um determinado produto.
Parâmetros de entrada
Tipo
idProduct
int
Parâmetros de saída
Tipo
CNPJ
string
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
56
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
fieldName
fieldValues
int
string
lista de string
57
StockKeepingUnitEspecificationInsertByFieldId
Inserir uma especificação para um sku a partir do id do campo.
Parâmetros de entrada
Tipo
idSku
fieldId
fieldValues
int
int
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
58
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
startingStockKeepingUnitId
topRows
DateTime
Int?
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
59
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.
60
Parâmetros de entrada
Tipo
stockKeepingUnitKit
StockKeepingUnitKitDTO
Parâmetros de saída
Tipo
objeto
StockKeepingUnitKitDTO
Dados obrigatórios (StockKeepingUnitKitDTO)
Tipo
Id
StockKeepingUnitId
StockKeepingUnitParent
Amount
UnitPrice
int
int
int
int
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
price
listPrice
costPrice
int
decimal
decimal
decimal
StockKeepingUnitPriceUpdateByRefId
Atualizar os preços de um dado sku a partir de seu refid.
Parâmetros de entrada
Tipo
stockKeepintUnitRefId
price
listPrice
costPrice
string
decimal
decimal
decimal
61
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
62
StoreList
Lista todas as lojas (multidomínio).
Parâmetros de saída
Tipo
Lista de objetos
StoreDTO
UpdateNotifyShipping
Atualizar o status do pedido para Faturado e integrar os dados de código de rastreio, notafiscal
etc.
Parâmetros de entrada
Tipo
OrderInvoice
OrderInvoiceDTO
WareHouseIStockableGetByStockKeepingUnit
Obter os dados de estoque de um determinado sku em um determinado estoque.
Parâmetros de entrada
Tipo
WareHouseId
SkuId
int
int
Parâmetros de saída
Tipo
objeto
WareHouseIStockableDTO
WareHouseIStockableGetByStockKeepingUnitV3
Obter os dados de estoque de um determinado sku em um determinado estoque.
Parâmetros de entrada
Tipo
SkuId
int
Parâmetros de saída
Tipo
lista de objetos
WareHouseIStockableDTO
WareHouseIStockableUpdate
Atualizar a quantidade de skus no estoque.
Parâmetros de entrada
Tipo
wareHouseId
itemId
availableQuantity
dateOfAvailability
int
int
int
DateTime
WareHouseIStockableUpdateV3
Atualizar a quantidade de skus no estoque.
Parâmetros de entrada
Tipo
wareHouseId
itemId
availableQuantity
dateOfAvailability
string
int
int
DateTime
63
ZipCodeGet
Buscar dados a partir de um dado zipcode.
Parâmetros de entrada
Tipo
zipCode
string
Parâmetros de saída
Tipo
objeto
ZipCodeDTO
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/
64
Link do instalador:
http://sourceforge.net/projects/soapui/files/soapui/3.6.1/soapUI-x32-3_6_1.ex
e/download
65