VTEX

coupon_id

text

[pt] Identificador do cupom.

expirationintervalperuse

text

[pt] Intervalo para reutilização do cupom.

isarchived

boolean

[pt] Indica se a promoção está arquivada.

lastmodifiedutc

timestamp

[pt] Data/hora UTC da última modificação.

maxitemsperclient

float

[pt] Quantidade máxima de itens por cliente.

utmcampaign

text

[pt] Filtro de campanha UTM.

utmsource

text

[pt] Filtro de origem UTM.

skuid

text

[pt] Identificador do SKU associado ao registro de estoque.

    SKUs > > skuid

warehouseid

text

[pt] Identificador do centro de distribuição.

warehousename

text

[pt] Nome do armazém ou loja responsável pelo estoque.

totalquantity

float

[pt] Quantidade total disponível no estoque.

reservedquantity

float

[pt] Quantidade reservada para pedidos em andamento.

hasunlimitedquantity

boolean

[pt] Indica se o SKU é tratado como estoque ilimitado.

id

text

[pt] Identificador da entidade no master data.

updatedin

timestamp

[pt] Momento em que o registro foi atualizado pela última vez

createdin

timestamp

[pt] Momento em que o registro foi criado

property_x

text

[pt] Exemplo de propriedade dinâmica

property_y

float

[pt] Exemplo numérico de propriedade dinâmica

property_z

date

[pt] Exemplo de propriedade dinâmica em formato de data

orderid

text

[pt] Identificador do pedido no OMS VTEX.

origin

text

[pt] Origem do pedido, como Marketplace ou Fulfillment.

status

text

[pt] Status do pedido.

workflowinerrorstate

boolean

[pt] Indica se o workflow deste pedido está em retentativa.

lastmessageunread

text

[pt] Última mensagem transacional ainda não lida.

sequence

float

[pt] Identificador sequencial interno do pedido.

callcenteroperatorname

text

[pt] Nome do operador de call center associado ao pedido.

paymentnames

text

[pt] Nomes amigáveis dos meios de pagamento usados.

affiliateid

text

[pt] Nome do estabelecimento responsável pelo pedido.

shippingestimateddatemax

timestamp

[pt] Data máxima estimada para entrega do pedido.

invoiceinput

text

[pt] Dados enviados para a emissão da nota fiscal.

workflowinretry

boolean

[pt] Indica se o workflow está em retentativa.

shippingestimateddate

timestamp

[pt] Data prevista de envio ou entrega do pedido.

invoiceoutput

text

[pt] Resposta retornada após a emissão da nota fiscal.

marketplaceorderid

text

[pt] Identificador do pedido no marketplace parceiro.

hostname

text

[pt] Hostname VTEX que processou o pedido.

orderiscomplete

boolean

[pt] Indica se o pedido foi concluído.

listtype

text

[pt] Tipo da lista de presentes ligada ao pedido (quando houver).

totalvalue

float

[pt] Valor total do pedido em centavos.

saleschannel

text

[pt] Canal de vendas utilizado pelo pedido.

totalitems

float

[pt] Quantidade total de itens no pedido.

authorizeddate

timestamp

[pt] Data em que o pedido foi autorizado.

creationdate

timestamp

[pt] Data de criação do pedido.

statusdescription

text

[pt] Descrição textual do status do pedido.

listid

text

[pt] Identificador da lista de presentes relacionada, quando existir.

shippingestimateddatemin

timestamp

[pt] Data mínima estimada para entrega do pedido.

currencycode

text

[pt] Código da moeda conforme a norma ISO 4217.

clientname

text

[pt] Nome do cliente exibido no pedido.

orderid

text

[pt] Identificador do pedido ligado a estas informações logísticas.

    Pedidos > > orderid

itemindex

float

[pt] Posição do item na lista de logística.

    Pedidos: itens > > kdd_itemindex

addressid

text

[pt] Identificador do endereço usado para entrega.

deliverychannel

text

[pt] Canal logístico (entrega, retirada, pickup).

deliverycompany

text

[pt] Nome da transportadora ou parceiro responsável pela entrega.

deliverywindow

text

[pt] Janela de entrega planejada (quando informada).

listprice

float

[pt] Preço de tabela do item nesta opção logística (centavos).

lockttl

text

[pt] Prazo de bloqueio utilizado para reservar a janela de entrega.

pickuppointid

text

[pt] Identificador do ponto de retirada associado.

pickupstoreinfo__additionalinfo

text

[pt] Informações adicionais exibidas sobre o ponto de retirada.

pickupstoreinfo_addresstype

text

[pt] Tipo do endereço do ponto de retirada.

pickupstoreinfo_addressreceiver

text

[pt] Nome do responsável pelo ponto de retirada.

pickupstoreinfo_addressid

text

[pt] Identificador do endereço do ponto de retirada.

pickupstoreinfo_addresspostalcode

text

[pt] CEP do ponto de retirada.

pickupstoreinfo_addresscity

text

[pt] Cidade do ponto de retirada.

pickupstoreinfo_addressstate

text

[pt] UF/estado do ponto de retirada.

pickupstoreinfo_addresscountry

text

[pt] País do ponto de retirada.

pickupstoreinfo_addressstreet

text

[pt] Logradouro do ponto de retirada.

pickupstoreinfo_addressnumber

text

[pt] Número do endereço do ponto de retirada.

pickupstoreinfo_addressneighborhood

text

[pt] Bairro do ponto de retirada.

pickupstoreinfo_addresscomplement

text

[pt] Complemento do endereço do ponto de retirada.

pickupstoreinfo_addressreference

text

[pt] Referência/landmark para localizar o ponto de retirada.

pickupstoreinfo_addresscoordinates

text

[pt] Coordenadas geográficas do ponto de retirada.

pickupstoreinfo__dockid

text

[pt] Identificador do dock/porta usado para retirada.

pickupstoreinfo__friendlyname

text

[pt] Nome amigável exibido para o ponto de retirada.

pickupstoreinfo__ispickupstore

boolean

[pt] Indica se o local é habilitado para retirada.

polygonname

text

[pt] Nome do polígono logístico aplicado.

price

float

[pt] Preço do frete para este trecho (centavos).

selectedsla

text

[pt] Nome da SLA logística selecionada para o item.

sellingprice

float

[pt] Preço de venda efetivo da entrega (centavos).

shippingestimate

text

[pt] Estimativa textual do prazo de entrega.

shippingestimatedate

timestamp

[pt] Data estimada de entrega para esta opção.

shipsto

text

[pt] País de destino no padrão ISO 3166 alfa-3.

transittime

text

[pt] Tempo de trânsito informado para a rota.

orderid

text

[pt] Identificador do pedido vinculado à SLA.

itemindex

float

[pt] Posição do item nesta lista de SLAs.

slas__deliverychannel

text

[pt] Canal de entrega oferecido na SLA.

slas__deliverywindow

text

[pt] Janela de entrega prevista na SLA.

slas__id

text

[pt] Identificador da SLA.

slas__lockttl

text

[pt] Prazo de bloqueio usado pela SLA.

slas__name

text

[pt] Nome amigável da SLA.

slas__pickuppointid

text

[pt] Identificador do ponto de retirada da SLA.

pickupstoreinfo__additionalinfo

text

[pt] Informações adicionais exibidas sobre o ponto de retirada.

pickupstoreinfo_addresstype

text

[pt] Tipo de endereço do ponto de retirada.

pickupstoreinfo_addressreceiver

text

[pt] Nome do responsável no ponto de retirada.

pickupstoreinfo_addressid

text

[pt] Identificador do endereço do ponto de retirada.

pickupstoreinfo_addresspostalcode

text

[pt] CEP do ponto de retirada.

pickupstoreinfo_addresscity

text

[pt] Cidade do ponto de retirada.

pickupstoreinfo_addressstate

text

[pt] UF/estado do ponto de retirada.

pickupstoreinfo_addresscountry

text

[pt] País do ponto de retirada.

pickupstoreinfo_addressstreet

text

[pt] Logradouro do ponto de retirada.

pickupstoreinfo_addressnumber

text

[pt] Número do ponto de retirada.

pickupstoreinfo_addressneighborhood

text

[pt] Bairro do ponto de retirada.

pickupstoreinfo_addresscomplement

text

[pt] Complemento do endereço de retirada.

pickupstoreinfo_addressreference

text

[pt] Referência ou ponto de apoio do local de retirada.

pickupstoreinfo_addresscoordinates

text

[pt] Coordenadas do ponto de retirada.

pickupstoreinfo__dockid

text

[pt] Identificador do dock utilizado para retirada.

pickupstoreinfo__friendlyname

text

[pt] Nome amigável exibido para o ponto de retirada.

pickupstoreinfo__ispickupstore

boolean

[pt] Informa se o local está habilitado como loja de retirada.

slas__polygonname

text

[pt] Polígono aplicado à rota da SLA.

slas__price

float

[pt] Preço do frete cobrado pela SLA (centavos).

slas__shippingestimate

text

[pt] Estimativa de envio para esta SLA.

slas__transittime

text

[pt] Tempo de trânsito informado pela SLA.

orderid

text

[pt] Identificador do pedido vinculado ao deliveryId.

itemindex

float

[pt] Posição do item dentro da lista de deliveryIds.

deliveryids__accountcarriername

text

[pt] Nome da transportadora configurada na conta.

deliveryids__courierid

text

[pt] Identificador do courier neste deliveryId.

deliveryids__couriername

text

[pt] Nome exibido do courier.

deliveryids__dockid

text

[pt] Dock utilizado para despachar este deliveryId.

deliveryids__quantity

float

[pt] Quantidade de itens neste deliveryId.

deliveryids__warehouseid

text

[pt] Depósito responsável por este deliveryId.

orderid

text

[pt] Identificador do pedido relacionado aos dados de marketing.

    Pedidos > > orderid

utmsource

text

[pt] Parâmetro UTM Source associado ao pedido.

utmpartner

text

[pt] Parâmetro de parceiro (utmPartner) informado pelo lojista.

utmmedium

text

[pt] Parâmetro UTM Medium utilizado na campanha.

utmcampaign

text

[pt] Parâmetro UTM Campaign associado ao pedido.

coupon

text

[pt] Cupom de desconto do pedido (normalizado para maiúsculas).

    Coupons > > coupon_id

utmicampaign

text

[pt] Parâmetro interno de campanha (utmiCampaign).

utmipage

text

[pt] Parâmetro interno de página (utmiPage).

utmipart

text

[pt] Parâmetro interno de parte (utmiPart).

marketingtags

text

[pt] Lista de tags/identificadores de marketing enviados pelo pedido.

orderid

text

[pt] Identificador do pedido ao qual os dados de entrega pertencem.

    Pedidos > > orderid

address__addresstype

text

[pt] Tipo do endereço de entrega.

address__neighborhood

text

[pt] Bairro do endereço de entrega.

address__addressid

text

[pt] Identificador do endereço de entrega.

address__complement

text

[pt] Complemento do endereço de entrega.

address__number

text

[pt] Número do endereço de entrega.

address__street

text

[pt] Logradouro do endereço de entrega.

address__geocoordinates

text

[pt] Coordenadas geográficas do endereço de entrega.

address__city

text

[pt] Cidade do endereço de entrega.

address__reference

text

[pt] Referência do endereço de entrega.

address__receivername

text

[pt] Nome do destinatário da entrega.

address__country

text

[pt] País de entrega no formato ISO 3166 ALPHA-3.

address__state

text

[pt] Estado/UF do endereço de entrega.

address__postalcode

text

[pt] CEP ou código postal do endereço de entrega.

orderid

text

[pt] Pedido ao qual o endereço selecionado pertence.

selectedaddresses__addresstype

text

[pt] Tipo de endereço selecionado (entrega, cobrança, retirada).

selectedaddresses__neighborhood

text

[pt] Bairro registrado para o endereço escolhido.

selectedaddresses__addressid

text

[pt] Identificador interno do endereço selecionado.

selectedaddresses__complement

text

[pt] Complemento do endereço escolhido.

selectedaddresses__number

text

[pt] Número do endereço selecionado.

selectedaddresses__street

text

[pt] Logradouro do endereço selecionado.

selectedaddresses__geocoordinates

text

[pt] Coordenadas geográficas associadas ao endereço.

selectedaddresses__city

text

[pt] Cidade do endereço selecionado.

selectedaddresses__reference

text

[pt] Ponto de referência informado para facilitar a entrega.

selectedaddresses__receivername

text

[pt] Nome da pessoa que receberá a entrega.

selectedaddresses__country

text

[pt] País do endereço selecionado.

selectedaddresses__state

text

[pt] Estado/UF do endereço selecionado.

selectedaddresses__postalcode

text

[pt] CEP/código postal do endereço selecionado.

orderid

text

[pt] Identificador do pedido no OMS VTEX.

    Pedidos > > orderid

kdd_customer_id

text

[pt] Identificador aproximado do cliente gerado pela Kondado (experimental).

origin

text

[pt] Origem do pedido, como Marketplace ou Fulfillment.

totalitems

float

[pt] Quantidade total de itens no pedido.

clientname

text

[pt] Nome do cliente exibido no pedido.

marketplaceservicesendpoint

text

[pt] Endpoint configurado para integrações com o marketplace.

opentextfield

text

[pt] Campo livre para observações adicionais do pedido.

sequence

text

[pt] Identificador sequencial interno do pedido.

taxdata

text

[pt] Dados fiscais agregados retornados no pedido.

marketplaceorderid

text

[pt] Código do pedido no marketplace parceiro.

customdata

text

[pt] Estrutura personalizada com dados enviados pelo cliente.

followupemail

text

[pt] E-mail do responsável pela loja/atendimento.

ischeckedin

boolean

[pt] Informa se o pedido foi retirado no ponto físico.

lastchange

timestamp

[pt] Data da última alteração registrada no pedido.

subscriptiondata

text

[pt] Informações de assinatura ou recorrência vinculadas ao pedido.

iscompleted

boolean

[pt] Indica se o pedido foi concluído.

affiliateid

text

[pt] Nome do estabelecimento responsável pela venda.

lastmessage

text

[pt] Última mensagem transacional registrada para o pedido.

cancellationdata

text

[pt] Detalhes sobre cancelamentos solicitados ou concluídos.

clientprofiledata__corporatephone

text

[pt] Telefone corporativo informado pelo cliente.

clientprofiledata__iscorporate

boolean

[pt] Indica se o cliente é corporativo.

clientprofiledata__customerclass

text

[pt] Classificação comercial atribuída ao cliente.

clientprofiledata__corporatedocument

text

[pt] Documento corporativo (CNPJ ou similar) do cliente.

clientprofiledata__phone

text

[pt] Telefone principal informado no pedido.

clientprofiledata__userprofileid

text

[pt] Identificador do perfil de usuário no ambiente VTEX.

clientprofiledata__documenttype

text

[pt] Tipo de documento informado pelo cliente (CPF, passaporte etc.).

clientprofiledata__id

text

[pt] Identificador do registro de perfil do cliente.

clientprofiledata__firstname

text

[pt] Primeiro nome do cliente.

clientprofiledata__lastname

text

[pt] Sobrenome do cliente.

clientprofiledata__tradename

text

[pt] Nome fantasia informado para o cliente.

clientprofiledata__stateinscription

text

[pt] Inscrição estadual ou registro fiscal complementar do cliente.

clientprofiledata__corporatename

text

[pt] Razão social do cliente corporativo.

clientprofiledata__document

text

[pt] Documento principal do cliente (CPF, CNPJ etc.).

clientprofiledata__email

text

[pt] E-mail de contato informado pelo cliente.

orderformid

text

[pt] Identificador do formulário de pedido no VTEX.

creationdate

timestamp

[pt] Data de criação do pedido.

allowcancellation

boolean

[pt] Indica se o pedido aceita cancelamento.

changesattachment

text

[pt] Registros de anexos relacionados a alterações do pedido.

invoiceddate

timestamp

[pt] Data em que a nota fiscal foi emitida.

allowedition

boolean

[pt] Indica se o pedido aceita edição após criado.

merchantname

text

[pt] Nome do seller/loja responsável pelo pedido.

authorizeddate

timestamp

[pt] Data em que o pedido foi autorizado.

cancelreason

text

[pt] Motivo informado para cancelamento do pedido.

hostname

text

[pt] Hostname da conta registrado no License Manager.

callcenteroperatordata

text

[pt] Dados do operador de call center responsável pelo pedido.

value

float

[pt] Valor associado ao price tag aplicado ao pedido.

statusdescription

text

[pt] Descrição textual do status atual do pedido.

commercialconditiondata

text

[pt] Detalhes da condição comercial aplicada ao pedido.

ordergroup

text

[pt] Identificador do grupo de pedidos relacionado.

status

text

[pt] Status atual do pedido.

sellerorderid

text

[pt] Identificador do pedido no seller/marketplace.

giftregistrydata

text

[pt] Informações da lista de presentes vinculada ao pedido.

checkedinpickuppointid

text

[pt] Ponto de retirada onde o pedido foi conferido.

roundingerror

float

[pt] Total de diferenças originadas por arredondamento.

saleschannel

text

[pt] Identificador do canal de vendas do pedido.

marketplace__iscertified

text

[pt] Indica se o marketplace informado é certificado.

marketplace__baseurl

text

[pt] URL base do marketplace responsável pelo pedido.

marketplace__name

text

[pt] Nome do marketplace que originou o pedido.

orderid

text

[pt] Identificador do pedido ao qual o item pertence.

    Pedidos > > orderid

order_creationdate

timestamp

[pt] Data de criação do pedido referente ao item.

kdd_itemindex

int

[pt] Índice calculado que indica a posição do item no array de resposta do pedido (usado para referenciar outros pipelines com `itemindex`).

serialnumbers

text

[pt] Séries associadas ao item, quando aplicável.

offerings

text

[pt] Ofertas adicionais vinculadas ao item.

pricetags

text

[pt] Lista de etiquetas de preço e promoções aplicadas.

isgift

boolean

[pt] Indica se o item foi marcado como presente no pedido.

freightcommission

float

[pt] Valor de comissão de frete registrado para o seller.

commission

float

[pt] Comissão registrada para o seller.

params

text

[pt] Parâmetros adicionais aplicados ao item.

shippingprice

float

[pt] Valor de frete atribuído ao item.

ean

text

[pt] Código EAN do SKU.

parentassemblybinding

text

[pt] Referência ao conjunto pai do qual este item faz parte.

name

text

[pt] Nome exibido do item no pedido.

assemblies

text

[pt] Lista de componentes ou acessórios associados ao item.

pricedefinitions

text

[pt] Definições detalhadas de preços e descontos aplicados ao item.

measurementunit

text

[pt] Unidade de medida utilizada para o item.

unitmultiplier

float

[pt] Multiplicador aplicado à unidade de medida do item.

productid

text

[pt] Identificador do produto ao qual o item pertence.

refid

text

[pt] Código de referência configurado para o item.

taxcode

text

[pt] Código fiscal associado ao item.

pricevaliduntil

text

[pt] Data limite para manter o preço informado.

tax

float

[pt] Valor de impostos calculados para o item.

detailurl

text

[pt] URL pública (slug) para os detalhes do produto.

parentitemindex

text

[pt] Índice do item pai quando existe agrupamento ou kit.

callcenteroperator

text

[pt] Operador de call center responsável pelo item/pedido.

id

text

[pt] Identificador único retornado para o item.

seller

text

[pt] Seller (loja) responsável por este item.

uniqueid

text

[pt] Identificador único do item dentro do pedido.

costprice

float

[pt] Custo do item registrado no pedido (centavos).

presaledate

text

[pt] Data de pré-venda cadastrada para o item.

sellingprice

float

[pt] Preço de venda aplicado ao item (centavos).

sellersku

text

[pt] Identificador do SKU no seller.

    SKUs > > skuid

price

float

[pt] Preço base do item (centavos).

manualprice

text

[pt] Preço informado manualmente para o item.

rewardvalue

float

[pt] Valor de recompensa associado ao item.

lockid

text

[pt] Identificador da reserva (lock) do item.

imageurl

text

[pt] URL da imagem do SKU.

listprice

float

[pt] Preço de lista do item (centavos).

quantity

float

[pt] Quantidade do item no pedido.

additionalinfo__brandname

text

[pt] Nome da marca do item.

additionalinfo__brandid

text

[pt] Identificador numérico da marca do item.

additionalinfo__categoriesids

text

[pt] IDs das categorias vinculadas ao item.

_kdd_categories_sequence

text

[pt] Sequência de categorias do item separadas por > (calculado pela Kondado).

additionalinfo__productclusterid

text

[pt] Clusters de produtos associados ao item.

additionalinfo__commercialconditionid

text

[pt] Identificador da condição comercial aplicada ao item.

additionalinfo__offeringinfo

text

[pt] Descrição textual da oferta associada ao item.

additionalinfo__offeringtype

text

[pt] Tipo de oferta (por exemplo, desconto, brinde, serviço).

additionalinfo__offeringtypeid

text

[pt] Identificador do tipo de oferta aplicada.

additionalinfo__dimension__cubicweight

float

[pt] Peso cúbico do item.

additionalinfo__dimension__height

float

[pt] Altura do item.

additionalinfo__dimension__length

float

[pt] Comprimento do item.

additionalinfo__dimension__weight

float

[pt] Peso do item.

additionalinfo__dimension__width

float

[pt] Largura do item.

item_orderid

text

[pt] Pedido relacionado à categoria registrada.

uniqueid

text

[pt] Identificador único do item usado para ligação com a categoria.

additionalinfo__categories__id

text

[pt] Identificador da categoria listada para o item.

additionalinfo__categories__name

text

[pt] Nome da categoria registrada para o item.

orderid

text

[pt] Identificador do pedido.

    Pedidos > > orderid

isactive

boolean

[pt] Indica se a promoção está ativa.

merchantname

text

[pt] Nome do lojista.

status

text

[pt] Status atual da promoção.

transactionid

text

[pt] Identificador da transação.

orderid

text

[pt] Identificador do pedido.

    Pedidos > > orderid

transactionid

text

[pt] Identificador da transação.

payments_postalcode

text

[pt] CEP do endereço de pagamento.

payments_city

text

[pt] Cidade do endereço de pagamento.

payments_complement

text

[pt] Complemento do endereço de pagamento.

payments_country

text

[pt] País do endereço de pagamento.

payments_geocoordinates

text

[pt] Coordenadas do endereço de pagamento.

payments_neighborhood

text

[pt] Bairro do endereço de pagamento.

payments_number

text

[pt] Número do endereço de pagamento.

payments_reference

text

[pt] Referência para o endereço de pagamento.

payments_state

text

[pt] Estado/UF do endereço de pagamento.

payments_street

text

[pt] Logradouro do endereço de pagamento.

payments_message

text

[pt] Mensagem retornada pelo processador.

payments_returncode

text

[pt] Código de retorno do processador.

payments_accountid

text

[pt] Identificador da conta de pagamento.

payments_authid

text

[pt] Identificador de autorização retornado.

payments_bankissuedinvoicebarcodenumber

text

[pt] Código de barras do boleto emitido.

payments_bankissuedinvoicebarcodetype

text

[pt] Tipo de código de barras do boleto.

payments_bankissuedinvoiceidentificationnumber

text

[pt] Número identificador do boleto bancário.

payments_bankissuedinvoiceidentificationnumberformatted

text

[pt] Identificador formatado do boleto.

payments_cardholder

text

[pt] Nome do portador do cartão.

payments_duedate

date

[pt] Data de vencimento do pagamento.

payments_expiremonth

text

[pt] Mês de vencimento do cartão.

payments_expireyear

text

[pt] Ano de vencimento do cartão.

payments_firstdigits

text

[pt] Primeiros dígitos do cartão (BIN).

payments_giftcardasdiscount

text

[pt] Valor aplicado de gift card como desconto.

payments_giftcardcaption

text

[pt] Rótulo do gift card informado.

payments_giftcardid

text

[pt] Identificador do gift card utilizado no pagamento.

payments_giftcardname

text

[pt] Nome do gift card utilizado.

payments_giftcardprovider

text

[pt] Fornecedor do gift card.

payments_group

text

[pt] Grupo do pagamento (ex.: creditCard, bankInvoice).

payments_id

text

[pt] Identificador do pagamento dentro da transação.

payments_installments

float

[pt] Número de parcelas aplicadas.

payments_koinurl

text

[pt] URL retornada pela Koin quando aplicável.

payments_lastdigits

text

[pt] Últimos dígitos do cartão.

payments_ns

text

[pt] Número sequencial (NSU) retornado.

payments_parentaccountid

text

[pt] Identificador de conta pai do pagamento.

payments_paymentsystem

text

[pt] Identificador do meio de pagamento.

payments_paymentsystemname

text

[pt] Nome do meio de pagamento.

payments_redemptioncode

text

[pt] Código de resgate retornado.

payments_referencevalue

float

[pt] Valor de referência enviado ao meio de pagamento.

payments_tid

text

[pt] Identificador TID da transação.

payments_url

text

[pt] URL fornecida para o pagamento (redirect, boleto etc.).

payments_value

float

[pt] Valor do pagamento em centavos.

orderid

text

[pt] Identificador do pedido que recebeu a promoção.

    Pedidos > > orderid

description

text

[pt] Descrição da promoção aplicada.

featured

boolean

[pt] Indica se a promoção pode ser acumulada com outras.

promotion_id

text

[pt] Identificador único da promoção.

    Promotions > > promotion_id

name

text

[pt] Nome da promoção aplicada.

orderid

text

[pt] Pedido ao qual estes parâmetros casados pertencem.

promotion_id

text

[pt] Identificador único da promoção.

matchedparameters_key

text

[pt] Chave do parâmetro casado que aciona a promoção.

matchedparameters_val

text

[pt] Valor do parâmetro casado que satisfaz a condição.

orderid

text

[pt] Identificador do pedido no OMS VTEX.

    Pedidos > > orderid

totalvalue

float

[pt] Valor total do pedido (centavos).

totaldiscount

float

[pt] Total de descontos aplicados em centavos.

totalshipping

float

[pt] Total de frete cobrado em centavos.

totaltax

float

[pt] Total de impostos do pedido em centavos.

promotion_id

text

[pt] Identificador da promoção.

activategiftsmultiplier

boolean

[pt] Quando verdadeiro, ativa o multiplicador de brindes.

aresaleschannelidsexclusive

boolean

[pt] Define se os canais listados deixam a promoção exclusiva.

begindate

timestamp

[pt] Data inicial da promoção (UTC).

description

text

[pt] Descrição textual da promoção.

enddate

timestamp

[pt] Data final da promoção (UTC).

hasmaxpriceperitem

boolean

[pt] Informa se existe preço máximo por item para aplicar o benefício.

isactive

boolean

[pt] Indica se a promoção está ativa.

isarchived

boolean

[pt] Indica se a promoção está arquivada.

istax

boolean

[pt] Informa se a promoção atua como um imposto.

lastmodifiedutc

timestamp

[pt] Data/hora UTC da última modificação.

maxusage

float

[pt] Quantidade máxima de usos permitida.

name

text

[pt] Nome da promoção.

percentualtax

float

[pt] Percentual de imposto aplicado sobre o pedido.

scope_allcatalog

boolean

[pt] Define se a promoção atinge todo o catálogo.

scope_brands

float

[pt] Lista de marcas que acionam a promoção.

scope_brandsareinclusive

boolean

[pt] Quando verdadeiro, somente as marcas listadas se qualificam; caso contrário, são excluídas.

scope_categories

float

[pt] Categorias consideradas pela promoção.

scope_categoriesareinclusive

boolean

[pt] Define se as categorias listadas incluem ou excluem produtos.

scope_collections

float

[pt] Coleções às quais a promoção se aplica.

scope_collectionsareinclusive

boolean

[pt] Define se as coleções listadas incluem ou excluem produtos.

scope_products

float

[pt] Lista de produtos considerados no escopo.

scope_productsareinclusive

boolean

[pt] Define se os produtos listados incluem ou excluem a promoção.

scope_sellers

float

[pt] IDs de vendedores considerados no escopo.

scope_sellersareinclusive

boolean

[pt] Define se os vendedores listados incluem ou excluem o benefício.

scope_skus

float

[pt] SKUs cobertos pelo escopo.

scope_skusareinclusive

boolean

[pt] Define se os SKUs listados incluem ou excluem a promoção.

status

text

[pt] Status atual da promoção.

type

text

[pt] Tipo de promoção.

utmcampain

text

[pt] Filtro de campanha UTM.

utmsource

text

[pt] Filtro de origem UTM.

utmicampaign

text

[pt] Filtro interno de campanha UTM.

promotion_id

text

[pt] Identificador da promoção.

campaigns_value

text

[pt] Valor listado em campanhas.

promotion_id

text

[pt] Identificador da promoção.

idssaleschannel_value

float

[pt] Valor dentro de idsSalesChannel.

skuid

text

[pt] Identificador único do SKU.

width

float

[pt] Largura do SKU (cm).

packagedweightkg

float

[pt] Peso da embalagem em quilogramas.

height

float

[pt] Altura do SKU em centímetros.

unitmultiplier

float

[pt] Multiplicador aplicado à quantidade adicionada ao carrinho.

commercialconditionid

float

[pt] Identificador da condição comercial aplicada ao SKU.

refid

text

[pt] Código de referência configurado para o SKU.

iskit

boolean

[pt] Indica se o SKU representa um kit.

kititenssellapart

boolean

[pt] Define se os componentes do kit podem ser vendidos separadamente.

estimateddatearrival

text

[pt] Data estimada de chegada do SKU ao estoque.

packagedwidth

float

[pt] Largura da embalagem do SKU (cm).

name

text

[pt] Nome exibido do SKU.

packagedheight

float

[pt] Altura da embalagem do SKU (cm).

packagedlength

float

[pt] Comprimento da embalagem do SKU (cm).

cubicweight

float

[pt] Peso cúbico calculado da embalagem.

length

float

[pt] Comprimento do SKU em centímetros.

productid

text

[pt] Identificador do produto ao qual o SKU pertence.

manufacturercode

text

[pt] Código do fabricante informado para o SKU.

measurementunit

text

[pt] Unidade de medida do SKU (ex.: un, kg).

weightkg

float

[pt] Peso do SKU em quilogramas.

rewardvalue

float

[pt] Valor de recompensa concedido ao comprar o SKU.

modaltype

text

[pt] Define o modelo de entrega/fulfillment do SKU.

creationdate

timestamp

[pt] Data de criação do SKU.

isactive

boolean

[pt] Indica se o SKU está ativo.

ean

text

[pt] EAN do SKU.

skuid

text

[pt] Identificador do SKU relacionado ao vídeo.

video_url

text

[pt] URL de vídeo associado ao SKU.

sku_kit_id

float

[pt] Identificador do SKU pai do kit.

    SKUs > > skuid

component_sku_id

float

[pt] Identificador do SKU componente vinculado ao kit.

    SKUs > > skuid

quantity

float

[pt] Quantidade do componente incluída no kit.

unitprice

float

[pt] Preço unitário atribuído ao componente do kit.

skuid

float

[pt] Identificador numérico do SKU.

    SKUs > > skuid

baseprice

float

[pt] Preço base de venda do SKU (centavos).

costprice

float

[pt] Custo de venda do SKU (centavos).

listprice

float

[pt] Preço de tabela do item nesta opção logística (centavos).

markup

float

[pt] Percentual de margem desejada para o SKU.

skuid

float

[pt] Identificador numérico do SKU.

    SKUs > > skuid

daterange_from

timestamp

[pt] Data e hora inicial da vigência do preço fixo.

daterange_up_to

timestamp

[pt] Data e hora final da vigência do preço fixo.

fixedprices_listprice

float

[pt] Preço de lista definido dentro da configuração de preço fixo.

fixedprices_minquantity

float

[pt] Quantidade mínima necessária para aplicar o preço fixo.

fixedprices_tradepolicyid

float

[pt] Identificador da política comercial responsável pelo preço fixo.

fixedprices_value

float

[pt] Valor em que o preço fixo deve ser cobrado.

id

text

[pt] Identificador numérico único do produto.

    Pedidos: itens > > productid

brandid

text

[pt] Identificador da marca associada ao produto.

categoryid

text

[pt] Identificador da categoria do produto.

departmentid

text

[pt] Identificador do departamento vinculado à categoria.

description

text

[pt] Descrição completa do produto.

descriptionshort

text

[pt] Descrição curta exibida em páginas e vitrines.

isactive

boolean

[pt] Indica se o produto está ativo para venda.

isvisible

boolean

[pt] Mostra (true) ou oculta (false) o produto em buscas e páginas, sem impedir a compra.

keywords

text

[pt] Palavras-chave ou sinônimos do produto, separados por vírgula (campo obsoleto).

linkid

text

[pt] Slug usado para montar a URL da página do produto; quando vazio, é gerado a partir do nome.

metatagdescription

text

[pt] Descrição curta para SEO; recomenda-se até 150 caracteres.

name

text

[pt] Nome do produto (máximo 150 caracteres).

refid

text

[pt] Código de referência configurado para o produto.

releasedate

timestamp

[pt] Usado para ordenar resultados de busca pela data de lançamento.

score

text

[pt] Valor utilizado para priorizar o produto nas pranchas de busca.

showwithoutstock

boolean

[pt] Quando true, ativa o recurso "avise-me" ao ficar sem estoque.

taxcode

text

[pt] Código fiscal do produto, utilizado para cálculo de impostos.

title

text

[pt] Título do produto (tag