Manual do WebService da VTEX Versão /10/2013

Transcrição

1 Manual do WebService da VTEX Versão /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 QueueDTO QueueTypeDTO...10 FieldDTO FreightDTO...11 FreightScheduledDateOptionDTO...11 FreightStockKeepingUnitContextDTO...11 FreightStockKeepingUnitDTO...12 FreightValueDTO...12 GiftCardDTO...12 GiftCardTransactionItemDTO...13 GiftListDTO...13 GiftListMemberDTO...14 GiftListStockKeepingUnitDTO...14 GiftListTypeDTO...15 ImageDTO

2 IntegrationInterfaceDTO...18 NewsletterDTO...18 OrderDeliveryDTO...18 OrderDiscountDTO...19 OrderDTO 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 WareHouseIStockableDTO...28 ZipCodeDTO...28 Métodos AddressByAddressClient...29 AddressGetByClientId...30 AddressGetByClientIdV AddressInsertByClientId

3 AddressInsertByCpfCnpj...30 BrandGet BrandGetByName...31 BrandInsertUpdate...31 BuyTogetherBuyGainInsertUpdate...32 BuyTogetherDeleteById...32 BuyTogetherInsertUpdate...32 BuyTogetherSkuListInsertUpdate...32 BuyTogethertakeXPayYInsertUpdate...32 CategoryGet...33 CategoryGetByName...33 CategoryInsertUpdate...33 ClientCandidateDeleteByCpfOr ClientCandidateDeleteById...34 ClientCandidateGet...34 ClientCandidateInsert...34 ClientGet ClientGetAllFromCreatedDateAndId...35 ClientGetByCPF...35 ClientGetBy ClientGetBy V ClientGetByGuid...36 ClientGetExtendedInfo...36 ClientGetExtendedInfoByCPF...36 ClientGetV ClientInsertUpdate...37 ClientRewardGet...37 ClientRewardGetByCPF...37 ClientRewardUpdate...38 ClientRewardUpdateByCPF...38 CollectionGet...38 CollectionInsertUpdate...38 DistributionCenterGet...39 DistributionCenterGetByTaxId QueueConfirmSending

4 QueueGetAllBetweenTimeIntervalAnd TypeId QueueNotSendedByType...40 FreightCalculate...40 FreightCalculateV FreightGet FreightGetAll...41 FreightInsertUpdate...41 FreightValueDeleteByFreight...42 FreightValueInsertUpdate...42 FreightValueInsertUpdateByList...42 GiftCardGet...43 GiftCardGetByRedeptionCode...43 GiftCardInsertUpdate...43 GiftCardTransactionItemInsert...43 GiftCardTransactionItemSetStatus...44 GiftListGet 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

5 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 OrderChangeStatusV OrderChangeTrackingNumber...53 OrderChangeTrackingNumberV OrderDeliveryBlankRemoveByDTO...54 OrderDeliveryChangeStatus...54 OrderDeliveryChangeStatusByManagementId...54 OrderDeliveryChangeTrackingNumber...54 OrderDeliveryInsertUpdate...54 OrderDeliveryUpdateManagementId...55 OrderGet OrderGetByClient...55 OrderGetByClientCpf...55 OrderGetByClient OrderGetByDeliveryId...56 OrderGetByManagementId...56 OrderGetByStatus...56 OrderGetByStatusAndPaymentId...57 OrderGetByStatusByQuantity...57 OrderGetByStatusV

6 OrderGetInteractions...57 OrderGetNewV OrderGetNext50FromId...58 OrderGetNext50FromIdAndDate...58 OrderGetNext50FromIdAndDateStatusChanged...58 OrderGetNext50FromIdV OrderGetV OrderGetV OrderItemUpdateOrderDeliveryId...59 OrderPaymentGetAll...60 OrderPayPalGetStatus...60 OrderStatusGetAll...60 ProductActive...60 ProductEspecificationInsert...60 ProductEspecificationInsertByFieldId...61 ProductEspecificationInsertByList...61 ProductEspecificationInsertByListFieldIds...61 ProductEspecificationListByProductId...61 ProductEspecificationTextInsertByFieldId...61 ProductGet 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

7 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 StoreList UpdateNotifyShipping...72 WareHouseIStockableGetByStockKeepingUnit...72 WareHouseIStockableGetByStockKeepingUnitV WareHouseIStockableUpdate...73 WareHouseIStockableUpdateV ZipCodeGet...73 Exemplos de egração na linguagem C#

8 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 s Tamanho Descrição Id nulável - Id do endereço Country 50 País State 2 Estado City 100 Cidade Street 150 Rua Number nulável - Número 8

9 More 100 Complemento Neighborhood 100 Bairro ZipCode 10 CEP ReferencePo max Ponto de referência AddressType 100 de endereço (Comercial, Residencial, etc.) UserGUID Guid nulável - Id do usuário AddressGUID Guid nulável - Id do endereço AddressNameV3 max de endereço (Comercial, Residencial, etc.) AddressOrderDTO Propriedades s Tamanho Descrição Id nulável - Id do endereço da compra ReceiverName 200 Nome do destinatário AddressName 200 Identificação do endereço (Casa dos pais, Trabalho, etc.) Country 100 País State 2 Estado City 100 Cidade Street 200 Rua Number nulável - Número More 100 Complemento Neighborhood 100 Bairro ZipCode 10 CEP ReferencePo max Ponto de referência Phone 50 Telefone CelPhone 50 Telefone celular OfficePhone 50 Telefone comercial AddressType 100 de endereço (Comercial, Residencial, etc.) NumberV3 max Número podendo conter letra BrandDTO Propriedades s Tamanho Descrição Id nulável - Id da marca Name 100 Nome Title 200 Título Description max Descrição Keywords max Palavras chaves IsActive bool nulável - Ativo AdWordsRemarketingCod 200 Código do AdWords e LomadeeCampaignCode 200 Código da campanha do Lomadee BuyTogetherBuyGainDTO Propriedades s Tamanho Descrição Id nulável - Id do compre junto Name 128 Nome 9

10 Description 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 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 s Tamanho Descrição Id nulável - Id do compre junto Name 128 Nome Description 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 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 s Tamanho Descrição Id nulável - Id do compre junto Name 128 Nome Description 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 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 s Tamanho Descrição Id nulável - Id da categoria Name 100 Nome FatherCategoryId nulável - Id da categoria pai Title 150 Texto que será inserido na tag TITLE do html Description max Descrição 10

11 Keywords 200 Palavras chaves IsActive bool nulável - Ativo AdWordsRemarketingCod 200 Código do AdWords e LomadeeCampaignCode 200 Código da campanha do Lomadee ClientCandidateDTO Propriedades s Tamanho Descrição IdGroupClientCandidate nulável - Id do grupo Name 100 Nome Text max Texto listcpf Lista de - Lista de cpfs list Lista de - Lista de s ClientDTO Propriedades s Tamanho Descrição Id nulável - Id do cliente AddressClientId nulável - Id do endereço FirstName 50 Primeiro nome LastName 100 Sobrenome NickName 50 Apelido 50 Password 100 Senha CpfCnpj 50 CPF/CNPJ Phone 50 Telefone CelPhone 50 Telefone celular OfficePhone 50 Telefone comercial DateBirth DateTime nulável - Data de nascimento CreateDate DateTime nulável - Data de cadastro LastLogonDate DateTime nulável - Data do último acesso (campo depreciado) ChangeDate DateTime nulável - Data da última alteração IsActive bool nulável - Ativo IsFraud bool nulável - Fraude IsCorporate bool nulável - Pessoa jurídica UserGuid Guid nulável - Id do usuário CompanyName 50 Razão social CompanyNickName 100 Nome fantasia Gender 1 Sexo IsNewsReceiver bool nulável - Recebe newsletter IsSMSNewsReceiver bool nulável - Recebe SMS news StateInscription 100 Inscrição estadual IsStateInscriptionImmune bool nulável - Isento de inscrição estadual Age nulável - Idade RewardGiftCardId nulável - Vale vinculado ao cliente para o uso do Flex ClientExtendedDTO Propriedades s Tamanho Descrição Client ClientDTO - Dados do cliente ClientFields Lista de s ClientFieldDTO - Lista contendo os dados de cadastro estendido 11

12 ClientFieldDTO Propriedades s Tamanho Descrição Name 100 Nome do cadastro estendido FieldId Int nulável - Id do campo IsActive bool nulável - Ativo IsRequired bool nulável - Obrigatório FieldValueId nulável - Id do campo valor Value 50 Valor FieldGroupId nulável - Data término FieldGroup 50 Nome do grupo CollectionDTO Propriedades s Tamanho Descrição Id nulável - Id da coleção Name 100 Nome ListInactiveProducts bool nulável - Lista produtos inativos Highlight bool nulável - Realça Searchable bool nulável - Buscável FromDate DateTime - Data início ToDate DateTime - Data término ProductIdCollection lista de - Lista de produtos que irão estar na coleção DistributionCenterDTO Propriedades s Tamanho Descrição DistributionCenterID nulável - Id do centro de distribuíção Name 50 Nome TaxID 14 Código fiscal HandlingTimeCost nulável - Tempo de manipulação Priority nulável - Prioridade QueueDTO Propriedades s Tamanho Descrição QueueId nulável - Id do na fila ClientId nulável - Id do cliente AdministratorId nulável - Id do administrador SupplierId nulável - Id do fornecedor QueueTypeId nulável - Id do tipo de OrderId nulável - Id do pedido StockKeepingUnitId nulável - Id do sku SenderName 250 Nome do remetente Sender 250 do remetente RecipientName 250 Nome do destinatário Recipient 250 do destinatário Subject 550 Assunto Text max Texto SendingDate DateTime nulável - Data de envio RegisterDate DateTime nulável - Data de registro QueueTypeDTO Propriedades s Tamanho Descrição QueueTypeId nulável - Id do tipo de LayoutId nulável - Id do layout Name 50 Nome SenderName 50 Nome do remetente Sender 50 do remetente Subject 100 Assunto 12

13 Position nulável - Posição RecipientName 100 Nome do destinatário Recipient 100 do destinatário IsActive bool nulável - Ativo FieldDTO Propriedades s Tamanho Descrição Name 100 Nome do campo CategoryId nulável - Id da categoria FieldId nulável - Id do campo IsActive bool nulável - Ativo IsRequired bool nulável - Obrigatório FieldTypeId nulável - Id do tipo do campo FieldTypeName 100 Nome do tipo do campo FieldValueId nulável - Id do valor do campo Description - Descrição IsStockKeepingUnit bool nulável - É campo de sku FreightDTO ((transportadora) Ex.: Sedex, e-sedex, Total Express) Propriedades s Tamanho Descrição FreightID nulável - Id do frete DistributionCenterID nulável - Id do centro de distribuição ModalID nulável - Id do modal (Pesado, Leve, Refrigerado, Químico) Necessário DePara FreightTypeID nulável - Id do tipo de frete (Expresso, Econômico, Normal) - Necessário DePara Name 50 Nome do frete FreightScheduledDateOptionDTO Propriedades s Tamanho Descrição StartDate DateTime - Data e hora inicial EndDate DateTime - Data e hora final AvailablePeriods array de - Períodos disponíveis (Manhã, Tarde e Noite) FreightStockKeepingUnitContextDTO Propriedades s Tamanho Descrição StockKeepingUnitId - Id do sku Quantity - Quantidade FreightStockKeepingUnitDTO Propriedades s Tamanho Descrição StockKeepingUnitId - Id do sku Quantity - Quantidade FreightPrice decimal (18,2) Preço do frete DeliveryTime - Tempo de entrega FreightType max do frete (Sedex, 13

14 Normal etc) FreightTypeId max Id do tipo do frete FreightScheduledDateOption s lista de s FreightScheduledDateOptionDT - Dados da entrega agendada O FreightAdditionalInfo max Dados adicionais de frete FreightValueDTO Propriedades s Tamanho Descrição Id nulável - Id do valor do frete FreightId nulável - Id do frete ZipCodeStart nulável - Código postal inicial ZipCodeEnd nulável - Código postal final WeightStart decimal nulável (18,4) Peso inicial WeightEnd decimal nulável (18,4) Peso final AbsoluteMoneyCost decimal nulável (18,2) Valor absoluto PricePercent decimal nulável (18,2) Porcentagem do preço PricePercentByWeight decimal nulável (18,2) Porcentagem do preço por peso ActiveStartDate DateTime nulável - Data de ativação ActiveEndDate DateTime nulável - Data de expiração MaxVolume decimal nulável (18,4) Volume máximo TimeCost nulável - Tempo CubedWeight decimal nulável (18,4) Peso cúbico GiftCardDTO Propriedades s Tamanho Descrição Id nulável - Id do GiftCard (este campo é apenas para consulta) RedeptionCode 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 20 CPF/CNPJ do usuário Funds decimal nulável (18,2) Fundos (este campo é apenas para consulta) GiftCardTransactionItemDTO Propriedades s Tamanho Descrição RedemptionCode 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 nulável - Id da compra StockKeepingUnitId nulável - Id do sku GiftListDTO Propriedades s Tamanho Descrição GiftListId nulável - Id da lista de presente ClientId nulável - Id do cliente FileId nulável - Id do arquivo GiftListTypeId nulável - Id do tipo da lista de presente 14

15 ClientAddressId nulável - Id do endereço do cliente GiftCardId nulável - Id do vale Name 300 Nome Gifted 200 Favorecido Message 1000 Mensagem UrlFolder 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 300 Local do evento EventCity 200 Cidade do evento EventState 2 Estado do evento IsPublic bool nulável - Público Version nulável - Versão da lista de presente GiftListMembers Lista de GiftListMemberDTO - Membros da lista de presente. GiftListMemberDTO Propriedades s Tamanho Descrição GiftListMemberId nulável - GiftListId nulável - Id da lista de casamento ClientId nulável - Id do cliente Title 100 Título Name 100 Nome Surname 100 Sobrenome Mail 100 E=mail Text1 200 Campo livre definido no cadastro da lista Text2 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 s Tamanho Descrição GiftListSkuId nulável - Id da lista de presente sku GiftListId nulável - Id da lista de presente SkuId nulável - Id do sku OrderId nulável - Id do pedido InsertedByClientId 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 1000 Mensagem de resposta do pedido OrderMessage 1000 Mensagem do pedido OrderMessageFrom 100 Remetente da mensagem OrderMessageTo 100 Destinatário da mensagem WishedByClientId - Id do cliente que deseja o sku 15

16 GiftListTypeDTO Propriedades s Tamanho Descrição GiftListTypeId nulável - Id do tipo de lista Name 200 Nome Description 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 nulável - Dias para expirar para visitantes DaysToExpireToMember s nulável - Dias para expirar para donos DaysToEventMin nulável - Dias mínimos para o evento DaysToEventMax nulável - Dias máximos para o evento MemberMin nulável - Quantidade de membros mínima MemberMax nulável - Quantidade de membros máxima MemberTitle 500 Título dos membros TextTitle1 100 Campo livre que ficará definido para as listas desse tipo TextTitle2 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 nulável - Versão ImageDTO Propriedades s Tamanho Descrição Id nulável - Id da imagem ArchiveFormatId nulável - Id do formato do arquivo ArchiveParentId nulável - Id do arquivo pai ArchiveTypeId nulável - Id do tipo de arquivo DateLastModified DateTime nulável - Data de última alteração Description 100 Descrição FileLocation 500 Localização do arquivo no servidor Height nulável - Altura HeightUnitMeasure 50 Unidade de medida Name 100 Nome Width nulável - Largura WidthUnitMeasure 50 Unidade de medida StockKeepingUnitId nulável - Id do sku IsMain bool nulável - É principal Label 500 Label da imagem Tag 500 Tag da imagem Url max Url da imagem IntegrationInterfaceDTO Propriedades s Tamanho Descrição InterfaceName 50 Nome da erface (chave) DateLastError DateTime nulável - Data do último erro DateLastSuccess DateTime nulável - Data do último sucesso InterfaceEnum enum ErrorType - Conversão do nome da 16

17 erface para enum NewsletterDTO Propriedades s Tamanho Descrição Id nulável - Id do newsletter Name 100 Nome Data DateTime nulável - Data IsPersisted bool nulável - Persistido IsRemoved bool nulável - Removido OrderDeliveryDTO Propriedades s Tamanho Descrição Id nulável - Id da compra entrega OrderId nulável - Id do pedido OrderStatusId Id da situação (status) FreightId nulável - Id do frete InvoiceNumber 50 Número da NF TrackingNumber max Número de rastreamento DeliveryDate DateTime nulável - Data de entrega DateExpectedDelivery DateTime nulável - Data prevista de entrega StausChangeDate DateTime nulável - Data de alteração da situação (status) OrderStatus OrderStatusDTO - Situação (status) OrderItems lista de OrderItemDTO - Itens da compra entrega ManagementId nulável - Identificar do pedido no sistema ERP (opcional) FreightTypeId nulável - Id do tipo de frete (Expresso, Econômico, Normal) Necessário DePara StatusAdministratorId nulável - Id do administrador que realizou a última mudança de status ScheduleDate DateTime nulável - Data de agendamento ScheduleShift 50 Mudança de horário DaysForDistributionCenterProcessi ng nulável - Dias de processamento para o centro de distribuíção DaysForStockProcessing nulável - Dias de processamento para o estoque DaysForFreightDelivery nulável - Dias de entrega do frete DistributionCenter DistributionCenterDTO - Centro de distribuíção FreightName - Nome do frete 17

18 FreightIdV3 max Id do frete OrderDiscountDTO Propriedades s Tamanho Descrição Id nulável - Id do desconto OrderId nulável - Id do pedido SkuId nulável - Id do sku DiscountId nulável - Id do desconto Name max Nome da promoção OrderDTO Propriedades s Tamanho Descrição Id nulável - Id do pedido ClientId nulável - Id do cliente Media 255 Identifica a mídia que originou a compra (query utm_media) Source 255 Identifica origem da Compra (query utm_source) Campaign 255 Identifica a campanha de origem da compra (query utm_campaign) _Cost decimal nulável (18,2) Total do pedido PurchaseDate DateTime nulável - Data do pedido PurchaseDateUtc DateTime nulável - Data do pedido Utc TelemarketingId nulável - Id do usuário televendas TelemarketingLogin 50 Login do operador de telemarketing que realizou a compra TelemarketingStoreLocatorNam e 100 Se o operador estiver associado a uma loja física, exibe o nome da loja TelemarketingStoreLocatorCode 50 Se o operador estiver associado a uma loja física, exibe o código da loja TelemarketingObservation 50 Dado complementar ao preenchido ao entrar no modo televendas (CPF do vendedor, observação...) ClientIP 50 IP do cliente Keywords 255 Palavra chave que originou a compra (não é usada por enquanto) IsGiftList bool nulável - Lista de presente Coupon 50 Cupom Client ClientDTO - Cliente 18

19 Address OrderAddressDTO - Endereço de entrega OrderDeliveries lista de OrderDeliveryDTO - 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 OrderPayments lista de OrderPaymentDTO - Formas de pagamento GiftListStockKeepingUnits lista de GiftListStockKeepingUnitDTO - Skus de uma lista de presente ListOrderDiscount lista de OrderDiscountDTO - Lista de descontos StoreId - Id da loja StoreName 100 Nome da loja IsMultiStore bool - É multiloja Tax decimal nulável (18,2) Imposto IdV3 max Id do pedido AffiliateId max Id do Marketplace aonde o pedido foi feito OrderInteractionDTO Propriedades s Tamanho Descrição Id nulável - Id da eração OrderId - Id da compra ClientId nulável - Id do cliente Text - Texto Date Datetime - Data da eração StatusId enum StatusIdEnum - Status (Pending, InProgress e Completed) OrderInvoiceDTO Propriedades s Tamanho Descrição Courier max Transportadora EmbeddedInvoice max Texto da notafiscal InvoiceNumber max Número da notafiscal InvoiceUrl max Url da notafiscal eletrônica InvoiceValue max Valor da notafiscal IssuanceDate DateTime nulável - Data da geração da notafiscal OrderId nulável - Id do pedido (sequence) OrderIdV3 max Id do pedido TrackingNumber max Código de rastreio TrackingUrl max Url da transportadora 19

20 StockKeepingUnits array de s do tipo OrderInvoiceStockKeepingUnitDT O para ratreio - Skus da notafiscal OrderInvoiceStockKeepingUnitDTO Propriedades s Tamanho Descrição StockKeepingUnitId nulável - Id do sku Quantity nulável - Quantidade Price decimal nulável (18,2) Preço da notafiscal OrderItemDiscountDTO Propriedades s Tamanho Descrição DiscountName max Nome do desconto Value decimal nulável (18,2) Valor do desconto IsPercentual bool nulável - É percentual OrderItemDTO Propriedades s Tamanho Descrição Id nulável - Id do item do pedido ItemId nulável - Id do sku vendido. Não existe campo relativo à quantidade, cada item pode ter serviços específicos. ParentOrderItemId nulável - Id do item pai (utilizado em caso de kits) IsKit bool nulável - Kit RefId 50 Id de referência do sku OrderDeliveryId nulável - Id da compra entrega ShippingCost decimal nulável (18,2) Valor do frete ShippingCostOff decimal nulável (18,2) Valor do frete com desconto Cost decimal nulável (18,2) Preço CostOff decimal nulável (18,2) Preço com desconto GiftDiscountId nulável - Id do cupom de desconto BuyTogetherDiscountId nulável - Id do compre junto CupomValue decimal nulável (18,2) Valor do cupom CupomValueOff decimal nulável (18,2) Valor do item subtraído do cupom com desconto IsStockImpact bool nulável - Identifica se o item já deu baixa no estoque ou não (true = ainda em estoque) 20

21 StockLikelyId nulável - Id do estoque provável do produto OrderItemServices lista de OrderItemServiceDTO - Serviços do item (sku) ProductId nulável - Id do produto ProductRefId nulável - Código de referência do produto StockLikelyIdV3 max Id do estoque MeasurementUnit max Unidade de medida UnitMultiplier decimal nulável (18,2) Multiplicador da unidade Discounts lista de s do tipo - Lista de descontos OrderItemDiscountDTO ListPrice decimal nulável (18,2) Preço De OrderItemServiceDTO Propriedades s Tamanho Descrição Id nulável - Id do item de serviço do sku do pedido OrderItemId nulável - Id do item no pedido StockKeepingUnitServiceId nulável - Id do servico do sku ArchiveId nulável - Id do arquivo (utilizado para upload de arquivo) ListPrice decimal nulável (18,2) Preço De Price decimal nulável (18,2) Preço Por (preço real) GiftCardMessage max Mensagem do cartão de presente GiftCardFrom 100 Remetente cartão de presente GiftCardTo 100 Destinatário cartão de presente StockKeepingUnitService StockKeepingUnitServiceDTO - Serviços do sku OrderPaymentDTO Propriedades s Tamanho Descrição Id nulável - Id da forma de pagamento do pedido OrderId nulável - Id do pedido OrderPaymentStatusId nulável - Situação do pagamento (status) PaymentId nulável - Id da forma de pagamento GiftCardId nulável - Id do vale presente CardNumber 500 Número do cartão CardSecurityCode 300 Código de segurança do cartão Plots nulável - Quantidade de parcelas CostWithInterest decimal nulável (18,2) Valor com juros Interest decimal nulável (18,2) Juros CardName 50 Titular do cartão CardLast4Numbers 50 Últimos 4 digitos 21

22 CardFirst6Numbers 50 Primeiros 6 digitos CardYear 300 Ano de vencimento CardMonth 300 Mês de vencimento IsValid bool nulável - Válido Date DateTime nulável - Data do pedido Street 150 Rua City 100 Cidade State 2 Estado Number nulável - Número ZipCode 50 CEP Neighborhood 100 Bairro Country 50 Pais ReferencePo max Ponto de referência AddressType 100 de endereço Complement 100 Complemento Url 400 Url do boleto ou do ambiente para débito On-Line GiftCardRedemptionCode 255 Código de resgate do vale presente PaymentTransactionId 50 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 PaymentAuthorizationId 100 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 InstallmentValue decimal (18,2) Valor da parcela PaymentUniqueSerialNumber NSU OrderStatusDTO Propriedades s Tamanho Descrição Id 10 Id do status (CAP,ERP,etc) Description 100 Nome do status PaymentDTO Propriedades s Tamanho Descrição Id - Id da forma de pagamento Name 50 Nome da forma de pagamento IsActive bool nulável - Ativo Type 50 (Boleto, 22

23 Crédito, etc) ProductDTO Propriedades s Tamanho Descrição Id nulável - Id do produto Name 150 Nome do produto DepartmentId nulável - Id do departamento CategoryId 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 nulável - Id da marca LinkId 255 Url do produto (sem espaços e sem caracteres especiais) RefId 200 Código de referência IsVisible bool nulável - Visível Description max Descrição DescriptionShort max Descrição resumida (vitrine) ReleaseDate DateTime nulável - Data de lançamento KeyWords max Palavras-chaves Title 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 50 Código fiscal MetaTagDescription max MetaTagDescription SupplierId nulável - Id do fornecedor ShowWithoutStock bool - Exibe sem estoque ListStoreId lista de - Lista com os ids das lojas em que o produto pode ser exibido (multiloja) AdWordsRemarketingCode 200 Código do AdWords LomadeeCampaignCode 200 Código da campanha do Lomadee ProductFieldIdDTO Propriedades s Tamanho Descrição productid - Id do produto fieldid - Id do campo fieldvalues lista de max Valor(es) do campo 23

24 ProductFieldNameDTO Propriedades s Tamanho Descrição productid - Id do produto fieldid fieldname 100 Nome do campo fieldvalues lista de max Valor(es) do campo ServiceDTO Propriedades s Tamanho Descrição Id nulável - Id do serviço Name 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 s Tamanho Descrição Id nulável - Id do preço de serviço ServiceId nulável - Id do serviço Name 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 s Tamanho Descrição StockKeepingUnitId - Id do sku StockKeepingUnitComplement s lista de - Todos os ids de skus que são complementos de um determinado tipo ComplementType enum - do complemento (Acessório, sugestão ou similar) StockKeepingUnitDTO Propriedades s Tamanho Descrição Id nulável - Id do sku ProductId nulável - Id do produto IsActive bool nulável - O campo isactive define se o sku está ativo ou 24

25 inativo. É necessário utilizar o método "StockKeepingUnitActivat e" para ativar um sku. Caso seja preenchido como false, o sku será desativado. Name 200 Nome do sku RefId 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 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 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 150 Nome do produto IsAvaiable bool nulável - Disponível (depreciado) StockKeepingUnitEans lista de StockKeepingUnitEanDTO - 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 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 100 Código do fabricante ComercialConditionId nulável - Id da condição comercial MeasurementUnit - 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 s Tamanho Descrição Ean String 50 Código de barras (único). Esta informação é meramente informativa e não é 25

26 obrigatória*. *Para que um sku seja ativado é necessário que ele tenha código de referência ou EAN. StockKeepingUnitFieldIdDTO Propriedades s Tamanho Descrição idsku - Id do sku fieldid - Id do campo fieldvalues lista de max Valor(es) do campo StockKeepingUnitFieldNameDTO Propriedades s Tamanho Descrição idsku - Id do sku fieldid fieldname 100 Nome do campo fieldvalues lista de max Valor(es) do campo StockKeepingUnitKitDTO Propriedades s Tamanho Descrição Id nulável - Id do kit StockKeepingUnitParent nulável - Id do sku pai StockKeepingUnitId nulável - Id do sku Amount nulável - Quantidade de itens UnitPrice decimal nulável (18,2) Preço unitário StockKeepingUnitQuantityDTO Propriedades s Tamanho Descrição StockKeepingUnitId - Id do sku StockKeepingUnitComplement s lista de - Todos os ids de skus que são complementos de um determinado tipo ComplementType enum - do complemento (Acessório, sugestão ou similar) StockKeepingUnitServiceDTO Propriedades s Tamanho Descrição Id nulável - Id do serviço do sku ServiceId nulável - Id do serviço. Ex.: Garantia Estendida, Montagem ServicePriceId nulável - Id do preço do serviço StockKeepingUnitId nulável - Id do sku Name 50 Nome do serviço Description 100 Descrição IsActive bool nulável - Ativo ServicePrice ServicePriceDTO - Preço do serviço 26

27 StoreDTO Propriedades s Tamanho Descrição Id nulável - Id da loja Name - Id da loja IsAtive bool nulável - Ativo WareHouseIStockableDTO Propriedades s Tamanho Descrição WareHouseId nulável - Id do estoque StockKeepingUnitId nulável - Id do sku AvailableQuantity nulável - Estoque disponível ReservedQuantity nulável - Estoque reservado TotalQuantity nulável - Estoque total WareHouseIdV3 max Id do estoque WareHouseName max Nome do estoque ZipCodeDTO Propriedades s Tamanho Descrição City 100 Cidade Neighborhood 100 Bairro State 2 Estado StateFullName 100 Nome completo do estado Street 150 Rua Value 10 CEP 27

28 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. addressclientid AddressDTO AddressGetByClientId Obter todos os endereços de um dado cliente. clientid Lista de s AddressDTO AddressGetByClientIdV3 Obter todos os endereços de um dado cliente. clientidv3 28

29 Lista de s AddressDTO AddressInsertByClientId Inserir um novo endereço para um determinado cliente pelo seu id. ClientId ClientAddress AddressDTO AddressDTO AddressInsertByCpfCnpj Inserir um novo endereço para um determinado cliente pelo seu CpfCnpj. CpfCnpj ClientAddress AddressDTO AddressDTO BrandGet Obter as informações sobre uma determinado marca pelo id. idbrand BrandDTO BrandGetByName Obter as informações sobre uma determinado marca pelo nome. namebrand BrandDTO BrandInsertUpdate Inserir ou atualizar os dados de uma marca. 29

30 brand BrandDTO BrandDTO Dados obrigatórios (BrandDTO) Id* Name *O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo egrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente. BuyTogetherBuyGainInsertUpdate Insere/Altera um compre junto do tipo compre e ganhe. objbuytogetherbuygaindto BuyTogetherBuyGainDTO BuyTogetherBuyGainDTO BuyTogetherDeleteById Deleta um compre junto através do identificador do mesmo. buytogetherid BuyTogetherInsertUpdate Insere/Altera um compre junto. objbuytogetherdto BuyTogetherDTO BuyTogetherDTO BuyTogetherSkuListInsertUpdate Anexa as listas de skus a um determinado de compre junto ou Altera as listas de skus de um determinado compre junto. buytogetherid firstliststockkeepingunit secondliststockkeepingunit Lista de Lista de 30

31 BuyTogethertakeXPayYInsertUpdate Insere/Altera um compre junto do tipo pegue x e pague y. objbuytogethertakexpayydto BuyTogetherTakeXPayYDTO BuyTogetherTakeXPayYDTO CategoryGet Obter as informações sobre uma determinada categoria pelo id. idcategory Int CategoryDTO CategoryGetByName Obter as informações sobre uma determinada categoria pelo nome. namecategory String CategoryDTO CategoryInsertUpdate Inserir ou atualizar os dados de uma categoria. category CategoryDTO CategoryDTO Dados obrigatórios (CategoryDTO) Id* Name *O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo egrador. Caso seja passado nulo, iremos fazer o auto-incremento automaticamente. ClientCandidateDeleteByCpfOr Apagar as informações de um cliente candidadto por cpf ou . ClienteCandidato ClientCandidateDTO 31

32 ClientCandidateDeleteById Apagar as informações de um cliente candidato pelo id do grupo. idclientcandidate ClientCandidateGet Busca as informações de um determinado cliente candidato pelo id do grupo. idclustergrupoclientecandidato ClientCandidateDTO ClientCandidateInsert Inserir informações sobre um cliente candidato. ClienteCandidato ClientCandidateDTO ClientCandidateDTO ClientGet Obter as informações sobre um determinado cliente. idclient ClientDTO ClientGetAllFromCreatedDateAndId Busca todos os clientes através da data de cadastro e do identificador do cliente. datecreated startingclientid toprows DateTime nulável Lista de s ClientDTO ClientGetByCPF Obter as informações sobre um determinado cliente com um determinado CPF/CNPJ. 32

33 CpfCnpj ClientDTO ClientGetBy Obter as informações sobre um determinado cliente com um determinado . ClientDTO ClientGetBy V3 Obter as informações sobre um determinado cliente com um determinado . ClientDTO ClientGetByGuid Obter as informações sobre um determinado cliente com um determinado guid. guid ClientDTO ClientGetExtendedInfo Obter as informações de cadastro estendido de um dado cliente. clientid ClientExtendedDTO ClientGetExtendedInfoByCPF Obter as informações de cadastro estendido por um dado CpfCnpj. CpfCnpj 33

34 ClientExtendedDTO ClientGetV3 Obter as informações sobre um determinado cliente. idclient ClientDTO ClientInsertUpdate Inserir ou atualizar os dados de um cliente. cliente address ClientDTO AddressDTO Dados obrigatórios (ClientDTO) Name NickName CpfCnpj Password CreateDate IsActive IsCorporate, IsFraud IsNewsReceiver IsSMSNewsReceiver DateTime bool bool bool bool bool Dados obrigatórios (AddressDTO) ZipCode ClientRewardGet Obter as informações o valor de fidelidade de um dado cliente. clientid Valor decimal ClientRewardGetByCPF Obter as informações o valor de fidelidade de um dado cliente pelo seu CPF/CNPJ. 34

35 cpfcnpj Valor decimal ClientRewardUpdate Debitar ou creditar um valor de fidelidade de um dado cliente. clientid totalreward transactionaction decimal enum TransactionAction ClientRewardUpdateByCPF Debitar ou creditar um valor de fidelidade de um dado cliente pelo seu CPF/CNPJ. cpfcnpj totalreward transactionaction decimal enum TransactionAction CollectionGet Obter as informações sobre uma determinada coleção. Id CollectionDTO CollectionInsertUpdate Obter as informações sobre uma determinada coleção. collection CollectionDTO CollectionDTO Dados obrigatórios (CollectionDTO) Name FromDate ToDate ProductIdCollection DateTime DateTime lista de DistributionCenterGet Obter as informações sobre um determinado centro de distribuição. 35

36 iddistributioncenter DistributionCenterDTO DistributionCenterGetByTaxId Obter as informações sobre um determinado centro de distribuição a partir do taxid. taxid DistributionCenterDTO QueueConfirmSending Confirmar o envio de um dado . QueueId SendingDate Datetime QueueGetAllBetweenTimeIntervalAnd TypeId Obter lista de s não enviados de um determinado tipo e por ervalo de datas. initialtime finaltime initialid toprows typeid DateTime DateTime nulável nulável lista de s QueueDTO QueueNotSendedByType Obter lista de s não enviados de um determinado tipo. QueueTypeId lista de s QueueDTO 36

37 FreightCalculate Obtém o custo do frete mais barato para um dado sku. skuid zipcode distributioncenterid freighttypeid FreightValueDTO FreightCalculateV3 Obtém o custo do frete para um grupo de skus. freightskucontext zipcode lista de s do tipo FreightStockKeepingUnitContextDTO lista de s FreightStockKeepingUnitDTO FreightGet Obter as informações sobre um determinado frete. idfreight FreightDTO FreightGetAll Obter todos os fretes. lista de s FreightDTO FreightInsertUpdate Inserir ou atualizar os dados de um frete. freight FreightDTO FreightDTO 37

38 Dados obrigatórios (FreightDTO) FreightID* FreightTypeID ModalID Name *O id está sendo colocado como obrigatório pois é altamente recomendado que seja informado pelo egrador. 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. idfreight FreightValueInsertUpdate Inserir ou atualizar os dados de um valor de frete. freightvalue FreightValueDTO FreightValueDTO Dados obrigatórios (FreightValueDTO) FeightId ZipCodeEnd ZipCodeStart WeightEnd WeightStart AbsoluteMoneyCost PricePercent PricePercentByWeight decimal decimal decimal decimal decimal FreightValueInsertUpdateByList Inserir ou atualizar os dados dos valores de fretes a partir de uma lista. lstfreightvalue FreightValueDTO OBS.: Os s 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. Id 38

39 GiftCardDTO GiftCardGetByRedeptionCode Obter as informações sobre um determinado gift card. redeptioncode giftcard GiftCardDTO GiftCardInsertUpdate Inserir ou atualizar os dados de um gift card. giftcard GiftCardDTO GiftCardDTO Dados obrigatórios (GiftCardDTO) StatusId OwnerId EmissionDate ExpiringDate DateTime DateTime GiftCardTransactionItemInsert Inserir uma transação relacionada a um gift card. giftcardtransactionitem GiftCardTransactionItemDTO Success bool Dados obrigatórios (GiftCardTransactionItemDTO) RedemptionCode Value TransactionAction TransactionConfirmed decimal enum TransactionAction bool GiftCardTransactionItemSetStatus Ativa ou inativa uma débito/crédito baseado no id da compra e id do sku. OrderId 39

40 StockKeepingUnitId Quantity IsActive bool Success bool GiftListGet Obter as informações de uma lista. IdGiftList GiftListDTO GiftListGetAllBetweenEventDateIntervalAndId Obter as informações das listas por eventos dentro de um dado ervalo de data. eventdatebegin eventdateend startinggiftlistid toprows DateTime Datetime nulável lista de s GiftListDTO GiftListGetAllFromCreatedDateAndId Obter as informações das listas criadas dentro de um dado ervalo de data. createddate startinggiftlistid toprows Datetime nulável lista de s GiftListDTO GiftListGetAllFromModifiedDateAndId Obter as informações das listas alteradas dentro de um dado ervalo de data. modifieddate startinggiftlistid toprows Datetime nulável 40

41 lista de s GiftListDTO GiftListGetByClient Obter as informações de uma lista de um determinado cliente. clienteid lista de s GiftListDTO GiftListGetByCreatedDate Obter uma lista de gift list criados a partir de uma data. createddate DateTime lista de s GiftListDTO GiftListGetByGifted Obter uma lista de gift list criados a partir de uma data. createddate DateTime lista de s GiftListDTO GiftListGetByModifiedDate Obter uma lista de gift list alterados a partir de uma data. modifieddate DateTime lista de s lista de s GiftListDTO GiftListGetType Obter as informações de um tipo de lista. 41

42 gitlisttypeid GiftListTypeDTO GiftListInsertUpdate Inserir ou atualizar uma lista. giftlist GiftListDTO GiftListDTO Dados obrigatórios (GiftListDTO) ClientId GiftListTypeId ClientAddressId Gifted UrlFolder EventDate DateTime DataCreateDT DateTime GiftListMembers** Lista de s 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. GiftListMemberId GiftListId GiftListMemberInsertUpdate Inserir um membro em uma lista. giftlistmember lista de s GiftListMemberDTO Dados obrigatórios (GiftListDTO) GiftListId Nome Sobrenome isadmin isactive ClientId* 42

43 *Deve conter pelo menos um membro em uma GiftList com o campo ClientId preenchido, caso contrário não será possível gerenciá-la. lista de s GiftListMemberDTO GiftListSearch Obter uma lista de gift list dado uma consulta. clientname eventlocation eventcity eventdate DateTime nulável lista de s GiftListDTO GiftListSkuDelete Remover um sku de uma lista. giftlistid skuid Quantity GiftListSkuDeleteByList Remover uma coleção de skus de uma lista. giftlistid skuquantity lista de s skuquantitydto GiftListSkuGet Obter uma coleção de skus a partir de uma lista. idgiftlist lista de s GiftListStockKeepingUnitDTO GiftListSkuInsert Inserir sku em uma lista. 43

44 giftlistsku GiftListStockKeepingUnitDTO GiftListStockKeepingUnitDTO Dados obrigatórios (GiftListStockKeepingUnitDTO) GiftListId SkuId InsertedByClientId WishedByClientId* GiftListSkuSetPurchased Definir um sku da lista como "comprado". giftlistid skuid Quantity orderid GiftListV2Filters Obter uma lista de gift list dado uma consulta. giftlisttypeid giftlistid clientid eventdatesince eventdateuntil isactive nulável nulável nulável DateTime nulável DateTime nulável bool nulável lista de s GiftListDTO ImageInsertUpdate Inserir uma nova imagem (por enquanto não temos o update funcionando). 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). StockKeepingUnitId ArchiveTypeId nulável 44

45 ImageServiceCopyAllImagesFromSkuToSku Copia todas as imagens de um sku origem para outro sku destino. stockkeepingunitidfrom stockkeepingunitidto ImageServiceInsertUpdate Inserir uma imagem relacionada a um sku. urlimage imagename stockkeepingunitid fileid nulável IntegrationErrorCheckInstanceExists Busca se um dado tipo de erro e id (instância) já existe logado. errortype instance enum ErrorType String IntegrationInterfaceGetAll Obter todas as as erfaces disponíveis para egração e suas datas de sucesso e falha. lista de s IntegrationInterfaceDTO IntegrationLog Inserir o tipo de erro. errortype enum ErrorType IntegrationLogError Inserir o tipo de erro e o erro. errortype error enum ErrorType 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. errortype instance error enum ErrorType 45

46 errordetail IntegrationLogEvent Inserir um evento (ex.: sucesso na egração de um pedido vinculando a ele o id do pedido). errortype message orderid enum ErrorType nulável NewsletterGet Obter as informações sobre uma determinada Newsletter. NewsId NewsletterDTO NewsletterGetAll Obter as informações de todas as Newsletters cadastradas. lista de s NewsletterDTO NewsletterGetAllByDate Obter as informações de todas as Newsletters cadastradas a partir da data inicial e data final. BeginDate EndDate DateTime DateTime lista de s NewsletterDTO NewsletterGetPaged Obter as informações de Newsletters de forma paginada. page quantity Lista de s NewsletterDTO 46

47 OrderAcknowledge Altera o status do pedido para Sent egrado (CheckoutV2). Este método está descontinuado e será removido. Utilizar o método OrderChangeStatusV2. (Método depreciado) idorder OrderChangeStatus Alterar as informações de status de uma determinada compra. idorder statusorder OrderChangeStatusById Alterar o status de uma entrega a partir do id da entrega e o status. idorderdelivery statusorder OrderChangeStatusV2 Alterar as informações de status de uma determinada compra (CheckoutV2). orderid egrationstatus enum IntegrationStatus OrderChangeTrackingNumber Alterar o tracking number (código de rastreio) a partir do id da compra. idorder trackingnumber OrderChangeTrackingNumberV2 Alterar o tracking number (código de rastreio) a partir do id da compra (CheckoutV2). idorder trackingnumber OrderDeliveryBlankRemoveByDTO Remover uma compra entrega a partir de um OrderDTO. 47

48 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 egraçã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. orderid statusorder ManagementId AdministratorId items lista de s OrderItem OrderDeliveryChangeStatusByManagementId Alterar o status de uma compra entrega a partir do id de gerenciamento. statusorder ManagementId OrderDeliveryChangeTrackingNumber Alterar o status de uma compra entrega a partir do número de rastreamento. idorderdelivery trackingnumber OrderDeliveryInsertUpdate Inserir ou alterar uma compra entrega. orderdeliverydto OrderDeliveryDTO OrderDeliveryDTO Dados obrigatórios (OrderDeliveryDTO) Id OrderId OrderStatusId StatusChangeDate StatusAdministratorId DateTime OrderDeliveryUpdateManagementId Alterar uma compra entrega a partir do id de gerenciamento. 48