VTEX

Creating the data source

  1. Access the VTEX administrative panel with the master user account
  2. In the sidebar, go to Account Settings, then Account Management and then click Application Keys
  3. Click the Manage My Keys button, you will be taken to the My Keys page:
  4. Click the Generate Key button
  5. Enter a name for the application key being created
  6. IMPORTANT STEP: Click on +Add Profiles to associate the key with the desired access profiles - the application key will be able to authenticate integrations with the modules and functionalities to which the chosen profiles give access
  7. Click the Generate button
  8. A sharing URL will be displayed (share.vtex.com/credentials/...)
  9. OPEN THAT URL in a new browser tab
  10. The actual token will be displayed - COPY THE TOKEN (not the URL)
  11. Login to the Kondado platform and go to the add data sources page
  12. Select the VTEX data source and fill in the information as shown in the image below
      1. Account Name: is the first part of your VTEX admin URL. For example, if your URL is kondado.myvtex.com, the value to fill in is kondado
      2. Access Key: corresponds to the Application Key generated in step (5)
      3. Access Secret: corresponds to the Application Token copied in step (10)
    1. Name your data source and click SAVE

IMPORTANT: Paste the TOKEN in the Access Secret field, NOT the URL.



Recommended minimum scopes:
  • OMS > List orders - required for connection test and orders list
  • OMS > View order - required for order details
  • Catalog > Get Product and SKU - for SKUs and Products
  • Logistics > Logistics viewer - for Inventory
  • Pricing > View Prices - for Prices
  • Rates and Benefits > View Benefits and Promotions - for Promotions and Coupons

Reference: License Manager Resources

Pipelines

Summary

Relationship chart

Click to expand

Coupons

Replication type: Full

Campo Tipo

coupon_id

text

[en] Coupon identifier.

expirationintervalperuse

text

[en] Interval to re-use the coupon.

isarchived

boolean

[en] Shows if the promotion is archived.

lastmodifiedutc

timestamp

[en] UTC timestamp of last modification.

maxitemsperclient

float

[en] Max items per client allowed.

utmcampaign

text

[en] UTM campaign filter.

utmsource

text

[en] UTM source filter.

Inventory

Replication type: Full

Relationships:

SKU stock levels per warehouse.

Campo Tipo

skuid

text

[en] SKU identifier associated with this inventory record.

    SKUs > > skuid

warehouseid

text

[en] Identifier for the warehouse.

warehousename

text

[en] Name of the warehouse or store holding the stock.

totalquantity

float

[en] Total quantity available in inventory.

reservedquantity

float

[en] Quantity reserved for pending orders.

hasunlimitedquantity

boolean

[en] Indicates whether the SKU is treated as having unlimited stock.

Master data

  • To use this pipeline you need the ADMIN_DS permissions

Replication type: Incremental

Parameters:

  • Read start date (Savepoint): Data replication start date
  • Entity: Select the entity

Default Master Data table template returned when no custom entity is configured.

Campo Tipo

id

text

[en] Master data entity Id

updatedin

timestamp

[en] Timestamp of when record was last updated

createdin

timestamp

[en] Timestamp of when record was created

property_x

text

[en] Example of a dynamic property

property_y

float

[en] Numeric example of a dynamic property

property_z

date

[en] Date example of a dynamic property

Orders

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders
Campo Tipo

orderid

text

[en] Change receipt order Id

origin

text

[en] Order Origin: Marketplace or Fulfillment

status

text

[en] Order Status

workflowinerrorstate

boolean

[en] If is in a Work Flow Retry

lastmessageunread

text

[en] Last sent transactional message

sequence

float

[en] Order Sequence ID

callcenteroperatorname

text

[en] Call center operator name linked to the order.

paymentnames

text

[en] Payment System Name

affiliateid

text

[en] Seller Name who was responsible for the order

shippingestimateddatemax

timestamp

[en] Shipping Estimated Date Max

invoiceinput

text

[en] Payload stored when the invoice is issued.

workflowinretry

boolean

[en] If is in a Work Flow Retry

shippingestimateddate

timestamp

[en] Shipping Estimated Date

invoiceoutput

text

[en] Response captured after the invoice is issued.

marketplaceorderid

text

[en] Marketplace Order Id

hostname

text

[en] VTEX hostname responsible for processing the order.

orderiscomplete

boolean

[en] If is a Order Completed

listtype

text

[en] Type of gift list associated with the order, when applicable.

totalvalue

float

[en] Releated Gift List Type

saleschannel

text

[en] Order Sales Channel Id

totalitems

float

[en] Total Order Items

authorizeddate

timestamp

[en] Authorized Order Date

creationdate

timestamp

[en] Order Creation Date

statusdescription

text

[en] Status Description

listid

text

[en] Releated Gift List Id

shippingestimateddatemin

timestamp

[en] Shipping Estimated Date Min

currencycode

text

[en] Currency Code in ISO 4217

clientname

text

[en] Customer name shown on the order.

Orders Logistics Info

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Main object

Logistics details per order item, including channels, prices, and pickup info.

Campo Tipo

orderid

text

[en] Order Id

    Orders > > orderid

itemindex

float

[en] Item Index

    Orders items > > kdd_itemindex

addressid

text

[en] Identifier of the address used for this delivery leg.

deliverychannel

text

[en] Logistics channel (delivery, pickup, etc.).

deliverycompany

text

[en] Carrier or partner responsible for the delivery.

deliverywindow

text

[en] Planned delivery window when provided.

listprice

float

[en] Item list price for this logistics option (in cents).

lockttl

text

[en] Lock TTL used to reserve this delivery window.

pickuppointid

text

[en] Identifier of the pickup point associated with this SLA.

pickupstoreinfo__additionalinfo

text

[en] Additional information displayed about the pickup store.

pickupstoreinfo_addresstype

text

[en] Address type for the pickup store location.

pickupstoreinfo_addressreceiver

text

[en] Name of the contact person at the pickup point.

pickupstoreinfo_addressid

text

[en] Identifier of the pickup store address.

pickupstoreinfo_addresspostalcode

text

[en] Postal code of the pickup store.

pickupstoreinfo_addresscity

text

[en] City of the pickup store.

pickupstoreinfo_addressstate

text

[en] State/region of the pickup store.

pickupstoreinfo_addresscountry

text

[en] Country where the pickup store is located.

pickupstoreinfo_addressstreet

text

[en] Street of the pickup store address.

pickupstoreinfo_addressnumber

text

[en] Street number for the pickup location.

pickupstoreinfo_addressneighborhood

text

[en] Neighborhood of the pickup store.

pickupstoreinfo_addresscomplement

text

[en] Address complement for the pickup store.

pickupstoreinfo_addressreference

text

[en] Reference or landmark for the pickup store.

pickupstoreinfo_addresscoordinates

text

[en] Geographic coordinates of the pickup store.

pickupstoreinfo__dockid

text

[en] Dock identifier used for pickup operations.

pickupstoreinfo__friendlyname

text

[en] Friendly name shown to the shopper for the pickup store.

pickupstoreinfo__ispickupstore

boolean

[en] Indicates whether the location acts as a pickup store.

polygonname

text

[en] Name of the logistics polygon applied to the delivery.

price

float

[en] Freight price for this logistics leg (in cents).

selectedsla

text

[en] Name of the logistics SLA selected for the item.

sellingprice

float

[en] Effective shipping price charged (in cents).

shippingestimate

text

[en] Textual shipping time estimate.

shippingestimatedate

timestamp

[en] Estimated delivery date for this option.

shipsto

text

[en] Shipping Country in ISO 3166 ALPHA-3 abbreviation

transittime

text

[en] Transit time reported for the route.

vtex_logisticsinfo__slas

Available SLAs per item, including freight prices and pickup data.

Campo Tipo

orderid

text

[en] Order Id

itemindex

float

[en] Item Index

slas__deliverychannel

text

[en] Delivery channel offered in the SLA.

slas__deliverywindow

text

[en] Delivery window available in the SLA.

slas__id

text

[en] SLA identifier.

slas__lockttl

text

[en] Lock TTL used for the SLA option.

slas__name

text

[en] Friendly SLA name.

slas__pickuppointid

text

[en] Pickup point identifier for the SLA.

pickupstoreinfo__additionalinfo

text

[en] Additional information displayed about the pickup store.

pickupstoreinfo_addresstype

text

[en] Address type for the pickup store location.

pickupstoreinfo_addressreceiver

text

[en] Name of the contact person at the pickup point.

pickupstoreinfo_addressid

text

[en] Identifier of the pickup store address.

pickupstoreinfo_addresspostalcode

text

[en] Postal code of the pickup store.

pickupstoreinfo_addresscity

text

[en] City of the pickup store.

pickupstoreinfo_addressstate

text

[en] State/region of the pickup store.

pickupstoreinfo_addresscountry

text

[en] Country where the pickup store is located.

pickupstoreinfo_addressstreet

text

[en] Street of the pickup store address.

pickupstoreinfo_addressnumber

text

[en] Street number for the pickup location.

pickupstoreinfo_addressneighborhood

text

[en] Neighborhood of the pickup store.

pickupstoreinfo_addresscomplement

text

[en] Address complement for the pickup store.

pickupstoreinfo_addressreference

text

[en] Reference or landmark for the pickup store.

pickupstoreinfo_addresscoordinates

text

[en] Geographic coordinates of the pickup store.

pickupstoreinfo__dockid

text

[en] Dock identifier used for pickup operations.

pickupstoreinfo__friendlyname

text

[en] Friendly pickup store name shown to shoppers.

pickupstoreinfo__ispickupstore

boolean

[en] Indicates whether the location acts as a pickup store.

slas__polygonname

text

[en] Polygon applied to the SLA route.

slas__price

float

[en] Freight price charged by this SLA (in cents).

slas__shippingestimate

text

[en] Shipping estimate for this SLA.

slas__transittime

text

[en] Transit time informed by the SLA.

vtex_logisticsinfo__deliveryIds

Delivery identifiers detailing carriers and quantities.

Campo Tipo

orderid

text

[en] Order Id

itemindex

float

[en] Item Index

deliveryids__accountcarriername

text

[en] Carrier name configured on the account.

deliveryids__courierid

text

[en] Courier identifier selected for the delivery portion.

deliveryids__couriername

text

[en] Courier display name.

deliveryids__dockid

text

[en] Dock used to dispatch this delivery ID.

deliveryids__quantity

float

[en] Number of items included in this delivery ID.

deliveryids__warehouseid

text

[en] Warehouse responsible for this delivery ID.

Orders Marketing Data

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Campo Tipo

orderid

text

[en] Order Id

    Orders > > orderid

utmsource

text

[en] UTM Source parameter

utmpartner

text

[en] UTM partner/source parameter

utmmedium

text

[en] UTM Medium parameter

utmcampaign

text

[en] UTM Campaign parameter

coupon

text

[en] Order Discount Coupon [upper case applied by Kondado]

    Coupons > > coupon_id

utmicampaign

text

[en] UTMI internal campaign parameter

utmipage

text

[en] UTMI internal page parameter

utmipart

text

[en] UTMI internal part parameter

marketingtags

text

[en] Marketing tags array

Orders Shipping Data

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Main object

Main shipping data per order.

Campo Tipo

orderid

text

[en] Order Id

    Orders > > orderid

address__addresstype

text

[en] Shipping Address Type

address__neighborhood

text

[en] Shipping Neighborhood

address__addressid

text

[en] Shipping Address Id

address__complement

text

[en] Shipping Complement

address__number

text

[en] Shipping Number

address__street

text

[en] Shipping Street

address__geocoordinates

text

[en] Shipping Geo Coordinates Array

address__city

text

[en] Shipping City

address__reference

text

[en] Shipping Reference

address__receivername

text

[en] Shipping Receiver Name

address__country

text

[en] Shipping Country in ISO 3166 ALPHA-3 abbreviation

address__state

text

[en] Shipping State

address__postalcode

text

[en] Shipping Postal Code

vtex_orders_shipping_data__selectedAddresses

Selected addresses per order, including pickup locations.

Campo Tipo

orderid

text

[en] Related Order Id

selectedaddresses__addresstype

text

[en] Type of selected address (shipping, billing, pickup).

selectedaddresses__neighborhood

text

[en] Neighborhood recorded for the selected address.

selectedaddresses__addressid

text

[en] Internal identifier for the selected address.

selectedaddresses__complement

text

[en] Address complement for the selected location.

selectedaddresses__number

text

[en] Street number for the selected address.

selectedaddresses__street

text

[en] Street name for the selected address.

selectedaddresses__geocoordinates

text

[en] Geographic coordinates linked to the selected address.

selectedaddresses__city

text

[en] City of the selected address.

selectedaddresses__reference

text

[en] Reference landmark provided for the address.

selectedaddresses__receivername

text

[en] Name of the person designated to receive the order.

selectedaddresses__country

text

[en] Country of the selected address.

selectedaddresses__state

text

[en] State or region of the selected address.

selectedaddresses__postalcode

text

[en] Postal code of the selected address.

Orders details

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Complete order detail payload covering customer, marketplace, and status information.

Campo Tipo

orderid

text

[en] Change receipt order Id

    Orders > > orderid

kdd_customer_id

text

[en] An approximation ID for the customer generated by kondado (experimental)

origin

text

[en] Order Origin: 'Marketplace' or 'Fulfillment'

totalitems

float

[en] Total Order Items

clientname

text

[en] Customer name recorded on the order.

marketplaceservicesendpoint

text

[en] Endpoint used for marketplace service integrations.

opentextfield

text

[en] Free text field with additional order notes.

sequence

text

[en] Internal sequential identifier for the order.

taxdata

text

[en] Aggregated tax information returned within the order.

marketplaceorderid

text

[en] Marketplace Order Id

customdata

text

[en] Custom Data Object

followupemail

text

[en] Responsible store e-mail

ischeckedin

boolean

[en] Indicates whether the order was checked in at a pickup location.

lastchange

timestamp

[en] Order Last Change Date

subscriptiondata

text

[en] Subscription or recurrence information linked to the order.

iscompleted

boolean

[en] If is a Order Completed

affiliateid

text

[en] Seller Name who was responsible for the order

lastmessage

text

[en] Last transactional message recorded for the order.

cancellationdata

text

[en] Details about cancellation requests or completion.

clientprofiledata__corporatephone

text

[en] Cliente Corporate Telephone

clientprofiledata__iscorporate

boolean

[en] If the Client is a Corporate Client

clientprofiledata__customerclass

text

[en] Commercial class assigned to the customer.

clientprofiledata__corporatedocument

text

[en] Client Corporate Document

clientprofiledata__phone

text

[en] Client Telephone

clientprofiledata__userprofileid

text

[en] Client User Profile ID

clientprofiledata__documenttype

text

[en] Client Document Type

clientprofiledata__id

text

[en] Identifier of the client profile record.

clientprofiledata__firstname

text

[en] Client First Name

clientprofiledata__lastname

text

[en] Customer last name.

clientprofiledata__tradename

text

[en] Client Last Name

clientprofiledata__stateinscription

text

[en] Client Corporate Inscription

clientprofiledata__corporatename

text

[en] Client Corporate Name

clientprofiledata__document

text

[en] Client Document

clientprofiledata__email

text

[en] Client e-mail

orderformid

text

[en] Order Form Id

creationdate

timestamp

[en] Order Creation Date

allowcancellation

boolean

[en] If Cancellation is allowed

changesattachment

text

[en] Attachment data linked to order changes.

invoiceddate

timestamp

[en] Invoice Date

allowedition

boolean

[en] If Order Edition is allowed

merchantname

text

[en] Merchant Name

authorizeddate

timestamp

[en] Authorized Order Date

cancelreason

text

[en] Cancel Reason

hostname

text

[en] Account Hostname registered in License Manager

callcenteroperatordata

text

[en] Call Center Operator responsible for the order

value

float

[en] Price Tag Value

statusdescription

text

[en] Status Description

commercialconditiondata

text

[en] Details about the commercial condition applied to the order.

ordergroup

text

[en] Order Group Id

status

text

[en] Order Status

sellerorderid

text

[en] Order Seller Id

giftregistrydata

text

[en] Gift registry information associated with the order.

checkedinpickuppointid

text

[en] Pickup point where the order was checked in.

roundingerror

float

[en] Rounding Error Total Amount

saleschannel

text

[en] Order Sales Channel Id

marketplace__iscertified

text

[en] If is a Certified Marketplace

marketplace__baseurl

text

[en] Marketplace Base URL

marketplace__name

text

[en] Marketplace Name

Orders items

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Main object

Line items per order including pricing, quantities, and extra metadata.

Campo Tipo

orderid

text

[en] Order Id

    Orders > > orderid

order_creationdate

timestamp

[en] Order Creation Date

kdd_itemindex

int

[en] This field is calculated by Kondado and indicates the position of the given item within the order response array - useful for referrencing with other pipelines that use the field 'itemindex'

serialnumbers

text

[en] Serial numbers attached to the item when available.

offerings

text

[en] Additional offerings associated with the item.

pricetags

text

[en] List of price tags and promotions applied to the item.

isgift

boolean

[en] If this item is a gift in order context

freightcommission

float

[en] Commission value registered to the seller for freight.

commission

float

[en] Commission value registered to the seller.

params

text

[en] Additional parameters associated with the item.

shippingprice

float

[en] Item Shipping Price

ean

text

[en] SKU EAN

parentassemblybinding

text

[en] Reference to the parent assembly this item belongs to.

name

text

[en] Item Name

assemblies

text

[en] List of components or accessories linked to the item.

pricedefinitions

text

[en] Detailed price definitions and discounts applied to the item.

measurementunit

text

[en] Item Measurement Unit

unitmultiplier

float

[en] Item Unit Multiplier

productid

text

[en] Item Product ID

refid

text

[en] Item Reference ID

taxcode

text

[en] Item Tax Code

pricevaliduntil

text

[en] Date until which the current price remains valid.

tax

float

[en] Item Tax

detailurl

text

[en] Product Slug URL

parentitemindex

text

[en] Index of the parent item when part of a bundle or kit.

callcenteroperator

text

[en] Call Center Operator responsible for the order

id

text

[en] Item ID

seller

text

[en] Item Seller

uniqueid

text

[en] Item Order Unique ID

costprice

float

[en] Item cost recorded in the order (cents).

presaledate

text

[en] Item Pre Sale Date

sellingprice

float

[en] Item Selling Price

sellersku

text

[en] Seller SKU identifier

    SKUs > > skuid

price

float

[en] Item Price

manualprice

text

[en] Price manually set for the item.

rewardvalue

float

[en] Item Reward value

lockid

text

[en] Reservation ID

imageurl

text

[en] SKU Image URL

listprice

float

[en] Item List Price

quantity

float

[en] Item Quantity

additionalinfo__brandname

text

[en] Brand Name

additionalinfo__brandid

text

[en] Brand ID

additionalinfo__categoriesids

text

[en] Item Category IDs

_kdd_categories_sequence

text

[en] List of categories of the item separated by > (calculated by Kondado)

additionalinfo__productclusterid

text

[en] All related Product Clusters

additionalinfo__commercialconditionid

text

[en] Commercial Condition Id

additionalinfo__offeringinfo

text

[en] Offering Info

additionalinfo__offeringtype

text

[en] Offering Type

additionalinfo__offeringtypeid

text

[en] Offering Type Id

additionalinfo__dimension__cubicweight

float

[en] Item Cubic Weight

additionalinfo__dimension__height

float

[en] Item Height

additionalinfo__dimension__length

float

[en] Item Length

additionalinfo__dimension__weight

float

[en] Item Weight

additionalinfo__dimension__width

float

[en] Item Width

vtex_orders_items__additionalinfo__categories

Auxiliary table listing every category assigned to items.

Campo Tipo

item_orderid

text

[en] Related Order ID

uniqueid

text

[en] Related Item Order Unique ID

additionalinfo__categories__id

text

[en] Category Id

additionalinfo__categories__name

text

[en] Category Name

Orders payment transactions

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Main object

Campo Tipo

orderid

text

[en] Order Id

    Orders > > orderid

isactive

boolean

[en] Shows if the promotion is active.

merchantname

text

[en] Merchant name.

status

text

[en] Promotion status.

transactionid

text

[en] Transaction identifier.

vtex_payment_transactions__payments

Campo Tipo

orderid

text

[en] Order Id

    Orders > > orderid

transactionid

text

[en] Transaction identifier.

payments_postalcode

text

[en] Payment address postal code.

payments_city

text

[en] Payment address city.

payments_complement

text

[en] Payment address complement.

payments_country

text

[en] Payment address country.

payments_geocoordinates

text

[en] Payment address coordinates.

payments_neighborhood

text

[en] Payment address neighborhood.

payments_number

text

[en] Payment address number.

payments_reference

text

[en] Reference for the payment address.

payments_state

text

[en] Payment address state.

payments_street

text

[en] Payment address street.

payments_message

text

[en] Processor message or code description.

payments_returncode

text

[en] Return code from payment processor.

payments_accountid

text

[en] Payment account identifier.

payments_authid

text

[en] Authorization identifier returned.

payments_bankissuedinvoicebarcodenumber

text

[en] Bank issued invoice barcode.

payments_bankissuedinvoicebarcodetype

text

[en] Barcode type for bank invoice.

payments_bankissuedinvoiceidentificationnumber

text

[en] Identification number of bank invoice.

payments_bankissuedinvoiceidentificationnumberformatted

text

[en] Formatted identifier of bank invoice.

payments_cardholder

text

[en] Card holder name.

payments_duedate

date

[en] Payment due date.

payments_expiremonth

text

[en] Card expiration month.

payments_expireyear

text

[en] Card expiration year.

payments_firstdigits

text

[en] First digits of the card (BIN).

payments_giftcardasdiscount

text

[en] Amount applied from gift card as discount.

payments_giftcardcaption

text

[en] Gift card caption or label.

payments_giftcardid

text

[en] Gift card identifier used in payment.

payments_giftcardname

text

[en] Gift card name or label.

payments_giftcardprovider

text

[en] Gift card provider.

payments_group

text

[en] Payment group (creditCard, bankInvoice, etc.).

payments_id

text

[en] Payment identifier inside the transaction.

payments_installments

float

[en] Number of installments applied.

payments_koinurl

text

[en] URL returned by Koin when applicable.

payments_lastdigits

text

[en] Last digits of the card.

payments_ns

text

[en] NSU or sequential number returned.

payments_parentaccountid

text

[en] Parent account identifier for the payment.

payments_paymentsystem

text

[en] Payment system identifier.

payments_paymentsystemname

text

[en] Payment system name.

payments_redemptioncode

text

[en] Redemption code returned by lender.

payments_referencevalue

float

[en] Reference value informed to the payment system.

payments_tid

text

[en] Transaction identifier (TID).

payments_url

text

[en] URL provided for the payment (redirect, boleto, etc.).

payments_value

float

[en] Payment value in cents.

Orders rates and benefits

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Main object

Promotion details applied per order, including matched parameters.

Campo Tipo

orderid

text

[en] Order Seller Id

    Orders > > orderid

description

text

[en] Item Description

featured

boolean

[en] If it is allowed to acumulate the Rates and Benefits

promotion_id

text

[en] The id of the promotion[Kondado]

    Promotions > > promotion_id

name

text

[en] Promotion name

vtex_orders_rates_and_benefits_matchedParameters

List of matched parameters used to activate the promotion on this order.

Campo Tipo

orderid

text

[en] Order Seller Id

promotion_id

text

[en] The id of the promotion[Kondado]

matchedparameters_key

text

[en] Matched parameter key: condition used to apply the promotion.

matchedparameters_val

text

[en] Matched parameter value: data that satisfied the condition.

Orders totals

  1. Dates are in UTC timezone
  2. Orders with incomplete status are not returned

Replication type: Incremental with update window

Parameters:

  • Update window (days): After an order is made, it can still be modified. This parameter controls how many days after the creating date the same order will still be updated
  • Read start date (Savepoint): Initial value for the creation date to replicate the orders

Relationships:

Table containing consolidated financial totals per order.

Campo Tipo

orderid

text

[en] Change receipt order Id

    Orders > > orderid

totalvalue

float

[en] Itens total

totaldiscount

float

[en] Discounts total

totalshipping

float

[en] Shipping/freight total

totaltax

float

[en] Tax total

Promotions

Replication type: Full

Main object

Campo Tipo

promotion_id

text

[en] Promotion identifier.

activategiftsmultiplier

boolean

[en] If true, the gifts multiplier is activated.

aresaleschannelidsexclusive

boolean

[en] Defines whether listed sales channels make the promotion exclusive.

begindate

timestamp

[en] Promotion start timestamp (UTC).

description

text

[en] Promotion description.

enddate

timestamp

[en] Promotion end timestamp (UTC).

hasmaxpriceperitem

boolean

[en] Indicates whether there is a maximum price per item for the benefit.

isactive

boolean

[en] Shows if the promotion is active.

isarchived

boolean

[en] Shows if the promotion is archived.

istax

boolean

[en] Shows if the promotion behaves as a tax.

lastmodifiedutc

timestamp

[en] UTC timestamp of last modification.

maxusage

float

[en] Maximum number of uses allowed.

name

text

[en] Promotion name.

percentualtax

float

[en] Percentual tax applied to order value.

scope_allcatalog

boolean

[en] Defines if the promotion targets the entire catalog.

scope_brands

float

[en] Brands list that triggers the promotion.

scope_brandsareinclusive

boolean

[en] If true, only listed brands qualify; otherwise they are excluded.

scope_categories

float

[en] Categories considered by the promotion.

scope_categoriesareinclusive

boolean

[en] Whether listed categories include or exclude products.

scope_collections

float

[en] Collections considered by the promotion.

scope_collectionsareinclusive

boolean

[en] Whether listed collections include or exclude products.

scope_products

float

[en] Products list considered in the scope.

scope_productsareinclusive

boolean

[en] Defines if listed products include or exclude the promotion.

scope_sellers

float

[en] Seller IDs considered in the scope.

scope_sellersareinclusive

boolean

[en] Whether listed sellers include or exclude the promotion.

scope_skus

float

[en] SKU IDs covered by the scope.

scope_skusareinclusive

boolean

[en] Whether listed SKUs include or exclude the promotion.

status

text

[en] Promotion status.

type

text

[en] Promotion type.

utmcampain

text

[en] UTM campaign filter.

utmsource

text

[en] UTM source filter.

utmicampaign

text

[en] UTM internal campaign filter.

promotions__Campaigns

Campo Tipo

promotion_id

text

[en] Promotion identifier.

campaigns_value

text

[en] Value inside campaigns list.

promotions_idsSalesChannel

Campo Tipo

promotion_id

text

[en] Promotion identifier.

idssaleschannel_value

float

[en] Value inside idsSalesChannel list.

SKUs

Replication type: Full

Main object

Complete VTEX SKU catalog metadata.

Campo Tipo

skuid

text

[en] SKU ID

width

float

[en] SKU Width

packagedweightkg

float

[en] Packaged Weight in Kilos

height

float

[en] SKU Height

unitmultiplier

float

[en] Multiplies the amount of SKUs inserted on the cart

commercialconditionid

float

[en] Commercial Condition ID

refid

text

[en] SKU RefId

iskit

boolean

[en] Shows if the SKU is a Kit

kititenssellapart

boolean

[en] Defines if Kit components can be sold apart

estimateddatearrival

text

[en] SKU Estimated Date Arrival

packagedwidth

float

[en] Packaged Width

name

text

[en] SKU Name

packagedheight

float

[en] Packaged Height

packagedlength

float

[en] Packaged Length

cubicweight

float

[en] Cubic Weight

length

float

[en] SKU Length

productid

text

[en] Product ID

manufacturercode

text

[en] Manufacturer Code

measurementunit

text

[en] Measurement Unit

weightkg

float

[en] SKU Weight in Kilos

rewardvalue

float

[en] How much the client will get rewarded by buying the SKU

modaltype

text

[en] Defines deliver model

creationdate

timestamp

[en] SKU Creation Date

isactive

boolean

[en] Shows if the SKU is active

ean

text

[en] SKU EAN

vtex_skus_videos

Video URLs linked to each SKU.

Campo Tipo

skuid

text

[en] SKU ID

video_url

text

[en] SKU video URL

SKUs: kits

Replication type: Full

Relationships:

Composition of VTEX kit SKUs and their component quantities.

Campo Tipo

sku_kit_id

float

[en] Parent kit SKU identifier.

    SKUs > > skuid

component_sku_id

float

[en] Component SKU identifier linked to the kit.

    SKUs > > skuid

quantity

float

[en] Quantity of the component included in the kit.

unitprice

float

[en] Unit price assigned to the kit component.

SKUs: prices

Replication type: Full

Relationships:

Main object

Snapshot with VTEX SKU pricing attributes (base, list, cost, markup).

Campo Tipo

skuid

float

[en] SKU unique identifier number.

    SKUs > > skuid

baseprice

float

[en] SKU selling base price.

costprice

float

[en] SKU selling cost price.

listprice

float

[en] Item list price for this logistics option (in cents).

markup

float

[en] The profit percentage that is to be obtained from the sale of that SKU

vtex_skus_prices__fixedPrices

Fixed price rules configured per SKU and trade policy.

Campo Tipo

skuid

float

[en] SKU unique identifier number.

    SKUs > > skuid

daterange_from

timestamp

[en] Start datetime of the fixed-price validity window.

daterange_up_to

timestamp

[en] End datetime of the fixed-price validity window.

fixedprices_listprice

float

[en] List price defined inside the fixed-price configuration.

fixedprices_minquantity

float

[en] Minimum quantity required for the fixed price to apply.

fixedprices_tradepolicyid

float

[en] Trade policy identifier that owns this fixed price.

fixedprices_value

float

[en] Fixed price amount that must be charged.

Products

Replication type: Full

Relationships:

VTEX product catalog with commercial metadata.

Campo Tipo

id

text

[en] Product's unique numerical identifier.

    Orders items > > productid

brandid

text

[en] Brand ID associated with this product.

categoryid

text

[en] Category ID associated with this product.

departmentid

text

[en] Department ID according to the product's category.

description

text

[en] Product description.

descriptionshort

text

[en] Short product description. Can be displayed on product pages and shelves.

isactive

boolean

[en] Activate (true) or inactivate (false) the product.

isvisible

boolean

[en] Shows (true) or hides (false) the product in search results and product pages, but it can still be added to the cart.

keywords

text

[en] Deprecated. Keywords or synonyms related to the product, separated by commas.

linkid

text

[en] Slug used to build the product page URL. If not informed, it is generated from the product's name.

metatagdescription

text

[en] Brief description of the product for SEO. Recommended not to exceed 150 characters.

name

text

[en] Product's name. Limited to 150 characters.

refid

text

[en] Product Reference Code.

releasedate

timestamp

[en] Used for ordering search results by release date.

score

text

[en] Value used to set the priority on the search result page.

showwithoutstock

boolean

[en] If true, activates the Notify Me option when the product is out of stock.

taxcode

text

[en] Product tax code, used for tax calculation.

title

text

[en] Product's Title tag. Limited to 150 characters. Important for SEO.

Notes

  • Part of this documentation was automatically generated by AI and may contain errors. We recommend verifying critical information