Creating the data source
- Access the VTEX administrative panel with the master user account
- In the sidebar, go to Account Settings, then Account Management and then click Application Keys
- Click the Manage My Keys button, you will be taken to the My Keys page:
- Click the Generate Key button
- Enter a name for the application key being created
- 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
- Click the Generate button
- A sharing URL will be displayed (share.vtex.com/credentials/...)
- OPEN THAT URL in a new browser tab
- The actual token will be displayed - COPY THE TOKEN (not the URL)
- Login to the Kondado platform and go to the add data sources page
- Select the VTEX data source and fill in the information as shown in the image below

- 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
- Access Key: corresponds to the Application Key generated in step (5)
- Access Secret: corresponds to the Application Token copied in step (10)
- 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
Inventory
SKU stock levels per warehouse.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] SKU identifier associated with this inventory record. |
|
|
text |
[en] Identifier for the warehouse. |
|
|
text |
[en] Name of the warehouse or store holding the stock. |
|
|
float |
[en] Total quantity available in inventory. |
|
|
float |
[en] Quantity reserved for pending orders. |
|
|
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 | |
|---|---|---|
|
text |
[en] Master data entity Id |
|
|
timestamp |
[en] Timestamp of when record was last updated |
|
|
timestamp |
[en] Timestamp of when record was created |
|
|
text |
[en] Example of a dynamic property |
|
|
float |
[en] Numeric example of a dynamic property |
|
|
date |
[en] Date example of a dynamic property |
Orders
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Change receipt order Id |
|
|
text |
[en] Order Origin: Marketplace or Fulfillment |
|
|
text |
[en] Order Status |
|
|
boolean |
[en] If is in a Work Flow Retry |
|
|
text |
[en] Last sent transactional message |
|
|
float |
[en] Order Sequence ID |
|
|
text |
[en] Call center operator name linked to the order. |
|
|
text |
[en] Payment System Name |
|
|
text |
[en] Seller Name who was responsible for the order |
|
|
timestamp |
[en] Shipping Estimated Date Max |
|
|
text |
[en] Payload stored when the invoice is issued. |
|
|
boolean |
[en] If is in a Work Flow Retry |
|
|
timestamp |
[en] Shipping Estimated Date |
|
|
text |
[en] Response captured after the invoice is issued. |
|
|
text |
[en] Marketplace Order Id |
|
|
text |
[en] VTEX hostname responsible for processing the order. |
|
|
boolean |
[en] If is a Order Completed |
|
|
text |
[en] Type of gift list associated with the order, when applicable. |
|
|
float |
[en] Releated Gift List Type |
|
|
text |
[en] Order Sales Channel Id |
|
|
float |
[en] Total Order Items |
|
|
timestamp |
[en] Authorized Order Date |
|
|
timestamp |
[en] Order Creation Date |
|
|
text |
[en] Status Description |
|
|
text |
[en] Releated Gift List Id |
|
|
timestamp |
[en] Shipping Estimated Date Min |
|
|
text |
[en] Currency Code in ISO 4217 |
|
|
text |
[en] Customer name shown on the order. |
Orders Logistics Info
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Order Id |
|
|
float |
[en] Item Index |
|
|
text |
[en] Identifier of the address used for this delivery leg. |
|
|
text |
[en] Logistics channel (delivery, pickup, etc.). |
|
|
text |
[en] Carrier or partner responsible for the delivery. |
|
|
text |
[en] Planned delivery window when provided. |
|
|
float |
[en] Item list price for this logistics option (in cents). |
|
|
text |
[en] Lock TTL used to reserve this delivery window. |
|
|
text |
[en] Identifier of the pickup point associated with this SLA. |
|
|
text |
[en] Additional information displayed about the pickup store. |
|
|
text |
[en] Address type for the pickup store location. |
|
|
text |
[en] Name of the contact person at the pickup point. |
|
|
text |
[en] Identifier of the pickup store address. |
|
|
text |
[en] Postal code of the pickup store. |
|
|
text |
[en] City of the pickup store. |
|
|
text |
[en] State/region of the pickup store. |
|
|
text |
[en] Country where the pickup store is located. |
|
|
text |
[en] Street of the pickup store address. |
|
|
text |
[en] Street number for the pickup location. |
|
|
text |
[en] Neighborhood of the pickup store. |
|
|
text |
[en] Address complement for the pickup store. |
|
|
text |
[en] Reference or landmark for the pickup store. |
|
|
text |
[en] Geographic coordinates of the pickup store. |
|
|
text |
[en] Dock identifier used for pickup operations. |
|
|
text |
[en] Friendly name shown to the shopper for the pickup store. |
|
|
boolean |
[en] Indicates whether the location acts as a pickup store. |
|
|
text |
[en] Name of the logistics polygon applied to the delivery. |
|
|
float |
[en] Freight price for this logistics leg (in cents). |
|
|
text |
[en] Name of the logistics SLA selected for the item. |
|
|
float |
[en] Effective shipping price charged (in cents). |
|
|
text |
[en] Textual shipping time estimate. |
|
|
timestamp |
[en] Estimated delivery date for this option. |
|
|
text |
[en] Shipping Country in ISO 3166 ALPHA-3 abbreviation |
|
|
text |
[en] Transit time reported for the route. |
vtex_logisticsinfo__slas
Available SLAs per item, including freight prices and pickup data.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Order Id |
|
|
float |
[en] Item Index |
|
|
text |
[en] Delivery channel offered in the SLA. |
|
|
text |
[en] Delivery window available in the SLA. |
|
|
text |
[en] SLA identifier. |
|
|
text |
[en] Lock TTL used for the SLA option. |
|
|
text |
[en] Friendly SLA name. |
|
|
text |
[en] Pickup point identifier for the SLA. |
|
|
text |
[en] Additional information displayed about the pickup store. |
|
|
text |
[en] Address type for the pickup store location. |
|
|
text |
[en] Name of the contact person at the pickup point. |
|
|
text |
[en] Identifier of the pickup store address. |
|
|
text |
[en] Postal code of the pickup store. |
|
|
text |
[en] City of the pickup store. |
|
|
text |
[en] State/region of the pickup store. |
|
|
text |
[en] Country where the pickup store is located. |
|
|
text |
[en] Street of the pickup store address. |
|
|
text |
[en] Street number for the pickup location. |
|
|
text |
[en] Neighborhood of the pickup store. |
|
|
text |
[en] Address complement for the pickup store. |
|
|
text |
[en] Reference or landmark for the pickup store. |
|
|
text |
[en] Geographic coordinates of the pickup store. |
|
|
text |
[en] Dock identifier used for pickup operations. |
|
|
text |
[en] Friendly pickup store name shown to shoppers. |
|
|
boolean |
[en] Indicates whether the location acts as a pickup store. |
|
|
text |
[en] Polygon applied to the SLA route. |
|
|
float |
[en] Freight price charged by this SLA (in cents). |
|
|
text |
[en] Shipping estimate for this SLA. |
|
|
text |
[en] Transit time informed by the SLA. |
vtex_logisticsinfo__deliveryIds
Delivery identifiers detailing carriers and quantities.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Order Id |
|
|
float |
[en] Item Index |
|
|
text |
[en] Carrier name configured on the account. |
|
|
text |
[en] Courier identifier selected for the delivery portion. |
|
|
text |
[en] Courier display name. |
|
|
text |
[en] Dock used to dispatch this delivery ID. |
|
|
float |
[en] Number of items included in this delivery ID. |
|
|
text |
[en] Warehouse responsible for this delivery ID. |
Orders Marketing Data
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Order Id |
|
|
text |
[en] UTM Source parameter |
|
|
text |
[en] UTM partner/source parameter |
|
|
text |
[en] UTM Medium parameter |
|
|
text |
[en] UTM Campaign parameter |
|
|
text |
[en] Order Discount Coupon [upper case applied by Kondado] |
|
|
text |
[en] UTMI internal campaign parameter |
|
|
text |
[en] UTMI internal page parameter |
|
|
text |
[en] UTMI internal part parameter |
|
|
text |
[en] Marketing tags array |
Orders Shipping Data
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Order Id |
|
|
text |
[en] Shipping Address Type |
|
|
text |
[en] Shipping Neighborhood |
|
|
text |
[en] Shipping Address Id |
|
|
text |
[en] Shipping Complement |
|
|
text |
[en] Shipping Number |
|
|
text |
[en] Shipping Street |
|
|
text |
[en] Shipping Geo Coordinates Array |
|
|
text |
[en] Shipping City |
|
|
text |
[en] Shipping Reference |
|
|
text |
[en] Shipping Receiver Name |
|
|
text |
[en] Shipping Country in ISO 3166 ALPHA-3 abbreviation |
|
|
text |
[en] Shipping State |
|
|
text |
[en] Shipping Postal Code |
vtex_orders_shipping_data__selectedAddresses
Selected addresses per order, including pickup locations.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Related Order Id |
|
|
text |
[en] Type of selected address (shipping, billing, pickup). |
|
|
text |
[en] Neighborhood recorded for the selected address. |
|
|
text |
[en] Internal identifier for the selected address. |
|
|
text |
[en] Address complement for the selected location. |
|
|
text |
[en] Street number for the selected address. |
|
|
text |
[en] Street name for the selected address. |
|
|
text |
[en] Geographic coordinates linked to the selected address. |
|
|
text |
[en] City of the selected address. |
|
|
text |
[en] Reference landmark provided for the address. |
|
|
text |
[en] Name of the person designated to receive the order. |
|
|
text |
[en] Country of the selected address. |
|
|
text |
[en] State or region of the selected address. |
|
|
text |
[en] Postal code of the selected address. |
Orders details
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Change receipt order Id |
|
|
text |
[en] An approximation ID for the customer generated by kondado (experimental) |
|
|
text |
[en] Order Origin: 'Marketplace' or 'Fulfillment' |
|
|
float |
[en] Total Order Items |
|
|
text |
[en] Customer name recorded on the order. |
|
|
text |
[en] Endpoint used for marketplace service integrations. |
|
|
text |
[en] Free text field with additional order notes. |
|
|
text |
[en] Internal sequential identifier for the order. |
|
|
text |
[en] Aggregated tax information returned within the order. |
|
|
text |
[en] Marketplace Order Id |
|
|
text |
[en] Custom Data Object |
|
|
text |
[en] Responsible store e-mail |
|
|
boolean |
[en] Indicates whether the order was checked in at a pickup location. |
|
|
timestamp |
[en] Order Last Change Date |
|
|
text |
[en] Subscription or recurrence information linked to the order. |
|
|
boolean |
[en] If is a Order Completed |
|
|
text |
[en] Seller Name who was responsible for the order |
|
|
text |
[en] Last transactional message recorded for the order. |
|
|
text |
[en] Details about cancellation requests or completion. |
|
|
text |
[en] Cliente Corporate Telephone |
|
|
boolean |
[en] If the Client is a Corporate Client |
|
|
text |
[en] Commercial class assigned to the customer. |
|
|
text |
[en] Client Corporate Document |
|
|
text |
[en] Client Telephone |
|
|
text |
[en] Client User Profile ID |
|
|
text |
[en] Client Document Type |
|
|
text |
[en] Identifier of the client profile record. |
|
|
text |
[en] Client First Name |
|
|
text |
[en] Customer last name. |
|
|
text |
[en] Client Last Name |
|
|
text |
[en] Client Corporate Inscription |
|
|
text |
[en] Client Corporate Name |
|
|
text |
[en] Client Document |
|
|
text |
[en] Client e-mail |
|
|
text |
[en] Order Form Id |
|
|
timestamp |
[en] Order Creation Date |
|
|
boolean |
[en] If Cancellation is allowed |
|
|
text |
[en] Attachment data linked to order changes. |
|
|
timestamp |
[en] Invoice Date |
|
|
boolean |
[en] If Order Edition is allowed |
|
|
text |
[en] Merchant Name |
|
|
timestamp |
[en] Authorized Order Date |
|
|
text |
[en] Cancel Reason |
|
|
text |
[en] Account Hostname registered in License Manager |
|
|
text |
[en] Call Center Operator responsible for the order |
|
|
float |
[en] Price Tag Value |
|
|
text |
[en] Status Description |
|
|
text |
[en] Details about the commercial condition applied to the order. |
|
|
text |
[en] Order Group Id |
|
|
text |
[en] Order Status |
|
|
text |
[en] Order Seller Id |
|
|
text |
[en] Gift registry information associated with the order. |
|
|
text |
[en] Pickup point where the order was checked in. |
|
|
float |
[en] Rounding Error Total Amount |
|
|
text |
[en] Order Sales Channel Id |
|
|
text |
[en] If is a Certified Marketplace |
|
|
text |
[en] Marketplace Base URL |
|
|
text |
[en] Marketplace Name |
Orders items
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Order Id |
|
|
timestamp |
[en] Order Creation Date |
|
|
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' |
|
|
text |
[en] Serial numbers attached to the item when available. |
|
|
text |
[en] Additional offerings associated with the item. |
|
|
text |
[en] List of price tags and promotions applied to the item. |
|
|
boolean |
[en] If this item is a gift in order context |
|
|
float |
[en] Commission value registered to the seller for freight. |
|
|
float |
[en] Commission value registered to the seller. |
|
|
text |
[en] Additional parameters associated with the item. |
|
|
float |
[en] Item Shipping Price |
|
|
text |
[en] SKU EAN |
|
|
text |
[en] Reference to the parent assembly this item belongs to. |
|
|
text |
[en] Item Name |
|
|
text |
[en] List of components or accessories linked to the item. |
|
|
text |
[en] Detailed price definitions and discounts applied to the item. |
|
|
text |
[en] Item Measurement Unit |
|
|
float |
[en] Item Unit Multiplier |
|
|
text |
[en] Item Product ID |
|
|
text |
[en] Item Reference ID |
|
|
text |
[en] Item Tax Code |
|
|
text |
[en] Date until which the current price remains valid. |
|
|
float |
[en] Item Tax |
|
|
text |
[en] Product Slug URL |
|
|
text |
[en] Index of the parent item when part of a bundle or kit. |
|
|
text |
[en] Call Center Operator responsible for the order |
|
|
text |
[en] Item ID |
|
|
text |
[en] Item Seller |
|
|
text |
[en] Item Order Unique ID |
|
|
float |
[en] Item cost recorded in the order (cents). |
|
|
text |
[en] Item Pre Sale Date |
|
|
float |
[en] Item Selling Price |
|
|
text |
[en] Seller SKU identifier |
|
|
float |
[en] Item Price |
|
|
text |
[en] Price manually set for the item. |
|
|
float |
[en] Item Reward value |
|
|
text |
[en] Reservation ID |
|
|
text |
[en] SKU Image URL |
|
|
float |
[en] Item List Price |
|
|
float |
[en] Item Quantity |
|
|
text |
[en] Brand Name |
|
|
text |
[en] Brand ID |
|
|
text |
[en] Item Category IDs |
|
|
text |
[en] List of categories of the item separated by > (calculated by Kondado) |
|
|
text |
[en] All related Product Clusters |
|
|
text |
[en] Commercial Condition Id |
|
|
text |
[en] Offering Info |
|
|
text |
[en] Offering Type |
|
|
text |
[en] Offering Type Id |
|
|
float |
[en] Item Cubic Weight |
|
|
float |
[en] Item Height |
|
|
float |
[en] Item Length |
|
|
float |
[en] Item Weight |
|
|
float |
[en] Item Width |
vtex_orders_items__additionalinfo__categories
Auxiliary table listing every category assigned to items.
Orders payment transactions
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Order Id |
|
|
boolean |
[en] Shows if the promotion is active. |
|
|
text |
[en] Merchant name. |
|
|
text |
[en] Promotion status. |
|
|
text |
[en] Transaction identifier. |
vtex_payment_transactions__payments
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Order Id |
|
|
text |
[en] Transaction identifier. |
|
|
text |
[en] Payment address postal code. |
|
|
text |
[en] Payment address city. |
|
|
text |
[en] Payment address complement. |
|
|
text |
[en] Payment address country. |
|
|
text |
[en] Payment address coordinates. |
|
|
text |
[en] Payment address neighborhood. |
|
|
text |
[en] Payment address number. |
|
|
text |
[en] Reference for the payment address. |
|
|
text |
[en] Payment address state. |
|
|
text |
[en] Payment address street. |
|
|
text |
[en] Processor message or code description. |
|
|
text |
[en] Return code from payment processor. |
|
|
text |
[en] Payment account identifier. |
|
|
text |
[en] Authorization identifier returned. |
|
|
text |
[en] Bank issued invoice barcode. |
|
|
text |
[en] Barcode type for bank invoice. |
|
|
text |
[en] Identification number of bank invoice. |
|
|
text |
[en] Formatted identifier of bank invoice. |
|
|
text |
[en] Card holder name. |
|
|
date |
[en] Payment due date. |
|
|
text |
[en] Card expiration month. |
|
|
text |
[en] Card expiration year. |
|
|
text |
[en] First digits of the card (BIN). |
|
|
text |
[en] Amount applied from gift card as discount. |
|
|
text |
[en] Gift card caption or label. |
|
|
text |
[en] Gift card identifier used in payment. |
|
|
text |
[en] Gift card name or label. |
|
|
text |
[en] Gift card provider. |
|
|
text |
[en] Payment group (creditCard, bankInvoice, etc.). |
|
|
text |
[en] Payment identifier inside the transaction. |
|
|
float |
[en] Number of installments applied. |
|
|
text |
[en] URL returned by Koin when applicable. |
|
|
text |
[en] Last digits of the card. |
|
|
text |
[en] NSU or sequential number returned. |
|
|
text |
[en] Parent account identifier for the payment. |
|
|
text |
[en] Payment system identifier. |
|
|
text |
[en] Payment system name. |
|
|
text |
[en] Redemption code returned by lender. |
|
|
float |
[en] Reference value informed to the payment system. |
|
|
text |
[en] Transaction identifier (TID). |
|
|
text |
[en] URL provided for the payment (redirect, boleto, etc.). |
|
|
float |
[en] Payment value in cents. |
Orders rates and benefits
- Dates are in UTC timezone
- 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 | |
|---|---|---|
|
text |
[en] Order Seller Id |
|
|
text |
[en] Item Description |
|
|
boolean |
[en] If it is allowed to acumulate the Rates and Benefits |
|
|
text |
[en] The id of the promotion[Kondado] |
|
|
text |
[en] Promotion name |
vtex_orders_rates_and_benefits_matchedParameters
List of matched parameters used to activate the promotion on this order.
Orders totals
- Dates are in UTC timezone
- 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:
Promotions
Replication type: Full
Main object
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Promotion identifier. |
|
|
boolean |
[en] If true, the gifts multiplier is activated. |
|
|
boolean |
[en] Defines whether listed sales channels make the promotion exclusive. |
|
|
timestamp |
[en] Promotion start timestamp (UTC). |
|
|
text |
[en] Promotion description. |
|
|
timestamp |
[en] Promotion end timestamp (UTC). |
|
|
boolean |
[en] Indicates whether there is a maximum price per item for the benefit. |
|
|
boolean |
[en] Shows if the promotion is active. |
|
|
boolean |
[en] Shows if the promotion is archived. |
|
|
boolean |
[en] Shows if the promotion behaves as a tax. |
|
|
timestamp |
[en] UTC timestamp of last modification. |
|
|
float |
[en] Maximum number of uses allowed. |
|
|
text |
[en] Promotion name. |
|
|
float |
[en] Percentual tax applied to order value. |
|
|
boolean |
[en] Defines if the promotion targets the entire catalog. |
|
|
float |
[en] Brands list that triggers the promotion. |
|
|
boolean |
[en] If true, only listed brands qualify; otherwise they are excluded. |
|
|
float |
[en] Categories considered by the promotion. |
|
|
boolean |
[en] Whether listed categories include or exclude products. |
|
|
float |
[en] Collections considered by the promotion. |
|
|
boolean |
[en] Whether listed collections include or exclude products. |
|
|
float |
[en] Products list considered in the scope. |
|
|
boolean |
[en] Defines if listed products include or exclude the promotion. |
|
|
float |
[en] Seller IDs considered in the scope. |
|
|
boolean |
[en] Whether listed sellers include or exclude the promotion. |
|
|
float |
[en] SKU IDs covered by the scope. |
|
|
boolean |
[en] Whether listed SKUs include or exclude the promotion. |
|
|
text |
[en] Promotion status. |
|
|
text |
[en] Promotion type. |
|
|
text |
[en] UTM campaign filter. |
|
|
text |
[en] UTM source filter. |
|
|
text |
[en] UTM internal campaign filter. |
promotions__Campaigns
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Promotion identifier. |
|
|
text |
[en] Value inside campaigns list. |
promotions_idsSalesChannel
SKUs
Replication type: Full
Main object
Complete VTEX SKU catalog metadata.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] SKU ID |
|
|
float |
[en] SKU Width |
|
|
float |
[en] Packaged Weight in Kilos |
|
|
float |
[en] SKU Height |
|
|
float |
[en] Multiplies the amount of SKUs inserted on the cart |
|
|
float |
[en] Commercial Condition ID |
|
|
text |
[en] SKU RefId |
|
|
boolean |
[en] Shows if the SKU is a Kit |
|
|
boolean |
[en] Defines if Kit components can be sold apart |
|
|
text |
[en] SKU Estimated Date Arrival |
|
|
float |
[en] Packaged Width |
|
|
text |
[en] SKU Name |
|
|
float |
[en] Packaged Height |
|
|
float |
[en] Packaged Length |
|
|
float |
[en] Cubic Weight |
|
|
float |
[en] SKU Length |
|
|
text |
[en] Product ID |
|
|
text |
[en] Manufacturer Code |
|
|
text |
[en] Measurement Unit |
|
|
float |
[en] SKU Weight in Kilos |
|
|
float |
[en] How much the client will get rewarded by buying the SKU |
|
|
text |
[en] Defines deliver model |
|
|
timestamp |
[en] SKU Creation Date |
|
|
boolean |
[en] Shows if the SKU is active |
|
|
text |
[en] SKU EAN |
vtex_skus_videos
Video URLs linked to each SKU.
SKUs: kits
SKUs: prices
Main object
Snapshot with VTEX SKU pricing attributes (base, list, cost, markup).
| Campo | Tipo | |
|---|---|---|
|
float |
[en] SKU unique identifier number. |
|
|
float |
[en] SKU selling base price. |
|
|
float |
[en] SKU selling cost price. |
|
|
float |
[en] Item list price for this logistics option (in cents). |
|
|
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 | |
|---|---|---|
|
float |
[en] SKU unique identifier number. |
|
|
timestamp |
[en] Start datetime of the fixed-price validity window. |
|
|
timestamp |
[en] End datetime of the fixed-price validity window. |
|
|
float |
[en] List price defined inside the fixed-price configuration. |
|
|
float |
[en] Minimum quantity required for the fixed price to apply. |
|
|
float |
[en] Trade policy identifier that owns this fixed price. |
|
|
float |
[en] Fixed price amount that must be charged. |
Products
VTEX product catalog with commercial metadata.
| Campo | Tipo | |
|---|---|---|
|
text |
[en] Product's unique numerical identifier. |
|
|
text |
[en] Brand ID associated with this product. |
|
|
text |
[en] Category ID associated with this product. |
|
|
text |
[en] Department ID according to the product's category. |
|
|
text |
[en] Product description. |
|
|
text |
[en] Short product description. Can be displayed on product pages and shelves. |
|
|
boolean |
[en] Activate (true) or inactivate (false) the product. |
|
|
boolean |
[en] Shows (true) or hides (false) the product in search results and product pages, but it can still be added to the cart. |
|
|
text |
[en] Deprecated. Keywords or synonyms related to the product, separated by commas. |
|
|
text |
[en] Slug used to build the product page URL. If not informed, it is generated from the product's name. |
|
|
text |
[en] Brief description of the product for SEO. Recommended not to exceed 150 characters. |
|
|
text |
[en] Product's name. Limited to 150 characters. |
|
|
text |
[en] Product Reference Code. |
|
|
timestamp |
[en] Used for ordering search results by release date. |
|
|
text |
[en] Value used to set the priority on the search result page. |
|
|
boolean |
[en] If true, activates the Notify Me option when the product is out of stock. |
|
|
text |
[en] Product tax code, used for tax calculation. |
|
|
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
