VTEX

coupon_id

text

[en] Coupon code [upper case applied by Kondado]

expirationintervalperuse

text

[en] Coupon expiration interval per use.

isarchived

boolean

[en] Defines if the coupon is archived (true) or not (false).

lastmodifiedutc

timestamp

maxitemsperclient

float

[en] Maximum items per client that the coupon can be applied.

utmcampaign

text

[en] UTM campaign code.

utmsource

text

[en] UTM source code.

skuid

text

    SKUs > > skuid

warehouseid

text

warehousename

text

totalquantity

float

reservedquantity

float

hasunlimitedquantity

boolean

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] an example of a dynamic property

property_y

float

[en] an example of a dynamic property

property_z

date

[en] an example of a dynamic property

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

paymentnames

text

[en] Payment System Name

affiliateid

text

[en] Seller Name who was responsible for the order

shippingestimateddatemax

timestamp

invoiceinput

text

workflowinretry

boolean

[en] If is in a Work Flow Retry

shippingestimateddate

timestamp

invoiceoutput

text

marketplaceorderid

text

[en] Marketplace Order Id

hostname

text

orderiscomplete

boolean

[en] If is a Order Completed

listtype

text

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

currencycode

text

[en] Currency Code in ISO 4217

clientname

text

orderid

text

[en] Order Id

    Orders > > orderid

itemindex

float

    Orders items > > kdd_itemindex

addressid

text

deliverychannel

text

deliverycompany

text

deliverywindow

text

listprice

float

lockttl

text

pickuppointid

text

pickupstoreinfo__additionalinfo

text

pickupstoreinfo_addresstype

text

pickupstoreinfo_addressreceiver

text

pickupstoreinfo_addressid

text

pickupstoreinfo_addresspostalcode

text

pickupstoreinfo_addresscity

text

pickupstoreinfo_addressstate

text

pickupstoreinfo_addresscountry

text

pickupstoreinfo_addressstreet

text

pickupstoreinfo_addressnumber

text

pickupstoreinfo_addressneighborhood

text

pickupstoreinfo_addresscomplement

text

pickupstoreinfo_addressreference

text

pickupstoreinfo_addresscoordinates

text

pickupstoreinfo__dockid

text

pickupstoreinfo__friendlyname

text

pickupstoreinfo__ispickupstore

boolean

polygonname

text

price

float

selectedsla

text

sellingprice

float

shippingestimate

text

shippingestimatedate

timestamp

shipsto

text

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

transittime

text

orderid

text

[en] Order Id

itemindex

float

slas__deliverychannel

text

slas__deliverywindow

text

slas__id

text

slas__lockttl

text

slas__name

text

slas__pickuppointid

text

pickupstoreinfo__additionalinfo

text

pickupstoreinfo_addresstype

text

pickupstoreinfo_addressreceiver

text

pickupstoreinfo_addressid

text

pickupstoreinfo_addresspostalcode

text

pickupstoreinfo_addresscity

text

pickupstoreinfo_addressstate

text

pickupstoreinfo_addresscountry

text

pickupstoreinfo_addressstreet

text

pickupstoreinfo_addressnumber

text

pickupstoreinfo_addressneighborhood

text

pickupstoreinfo_addresscomplement

text

pickupstoreinfo_addressreference

text

pickupstoreinfo_addresscoordinates

text

pickupstoreinfo__dockid

text

pickupstoreinfo__friendlyname

text

pickupstoreinfo__ispickupstore

boolean

slas__polygonname

text

slas__price

float

slas__shippingestimate

text

slas__transittime

text

orderid

text

[en] Order Id

itemindex

float

deliveryids__accountcarriername

text

deliveryids__courierid

text

deliveryids__couriername

text

deliveryids__dockid

text

deliveryids__quantity

float

deliveryids__warehouseid

text

orderid

text

[en] Order Id

    Orders > > orderid

utmsource

text

[en] UTM Source Parameters

utmpartner

text

[en] UTM Source Parameters

utmmedium

text

[en] UTM Medium Parameters

utmcampaign

text

[en] UTM Campaign Parameters

coupon

text

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

    Coupons > > coupon_id

utmicampaign

text

[en] UTMI Campaign Internal Parameters

utmipage

text

[en] UTMI Page Internal Parameters

utmipart

text

[en] UTMI Part Internal Parameters

marketingtags

text

[en] Marketing Tags Array

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

orderid

text

[en] Related Order Id

selectedaddresses__addresstype

text

selectedaddresses__neighborhood

text

selectedaddresses__addressid

text

selectedaddresses__complement

text

selectedaddresses__number

text

selectedaddresses__street

text

selectedaddresses__geocoordinates

text

selectedaddresses__city

text

selectedaddresses__reference

text

selectedaddresses__receivername

text

selectedaddresses__country

text

selectedaddresses__state

text

selectedaddresses__postalcode

text

orderid

text

[en] Change receipt order Id

    Orders > > orderid

origin

text

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

marketplaceservicesendpoint

text

[en] Marketplace Services Endpoint

opentextfield

text

[en] Open Text Field Object

sequence

text

[en] Order Sequence ID

taxdata

text

marketplaceorderid

text

[en] Marketplace Order Id

customdata

text

[en] Custom Data Object

followupemail

text

[en] Responsible store e-mail

ischeckedin

boolean

lastchange

timestamp

[en] Order Last Change Date

subscriptiondata

text

iscompleted

boolean

[en] If is a Order Completed

affiliateid

text

[en] Seller Name who was responsible for the order

lastmessage

text

cancellationdata

text

clientprofiledata__corporatephone

text

[en] Cliente Corporate Telephone

clientprofiledata__iscorporate

boolean

[en] If the Client is a Corporate Client

clientprofiledata__customerclass

text

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

clientprofiledata__firstname

text

[en] Client First Name

clientprofiledata__lastname

text

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

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

ordergroup

text

[en] Order Group Id

status

text

[en] Order Status

sellerorderid

text

[en] Order Seller Id

giftregistrydata

text

checkedinpickuppointid

text

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

orderid

text

[en] Order Id

    Orders > > orderid

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

offerings

text

pricetags

text

isgift

boolean

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

freightcommission

float

[en] Comission value registered to Seller

commission

float

[en] Comission value registered to Seller

params

text

shippingprice

float

[en] Item Shipping Price

ean

text

[en] SKU EAN

parentassemblybinding

text

name

text

[en] Item Name

assemblies

text

pricedefinitions

text

measurementunit

text

[en] Item Measurement Unit

unitmultiplier

float

[en] Item Unit Multipler

productid

text

[en] Item Product ID

refid

text

[en] Item Reference ID

taxcode

text

[en] Item Tax Code

pricevaliduntil

text

tax

float

[en] Item Tax

detailurl

text

[en] Product Slug URL

parentitemindex

text

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

presaledate

text

[en] Item Pre Sale Date

sellingprice

float

[en] Item Selling Price

sellersku

text

[en] Invoice Date

    SKUs > > skuid

price

float

[en] Item Price

manualprice

text

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 ID

additionalinfo__productclusterid

text

[en] All releated Product Clusters

additionalinfo__commercialconditionid

text

additionalinfo__offeringinfo

text

additionalinfo__offeringtype

text

additionalinfo__offeringtypeid

text

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

item_orderid

text

[en] Related Order ID

uniqueid

text

[en] Related Item Order Unique ID

additionalinfo__categories__id

text

additionalinfo__categories__name

text

orderid

text

    Orders > > orderid

isactive

boolean

[en] If is a active transaction

merchantname

text

[en] Transaction Merchant Name

status

text

[en] Transaction Status

transactionid

text

[en] Transaction Id

orderid

text

    Orders > > orderid

transactionid

text

[en] Transaction Id

payments_postalcode

text

payments_city

text

payments_complement

text

payments_country

text

payments_geocoordinates

text

payments_neighborhood

text

payments_number

text

payments_reference

text

payments_state

text

payments_street

text

payments_message

text

payments_returncode

text

[en] Connector Return Code

payments_accountid

text

payments_authid

text

[en] Connector Authorization Id

payments_bankissuedinvoicebarcodenumber

text

payments_bankissuedinvoicebarcodetype

text

payments_bankissuedinvoiceidentificationnumber

text

payments_bankissuedinvoiceidentificationnumberformatted

text

payments_cardholder

text

[en] Payment Card Holder

payments_duedate

date

[en] Payment Due Date

payments_expiremonth

text

[en] Payment Card expire Month

payments_expireyear

text

[en] Payment Card expire Year

payments_firstdigits

text

[en] Payment Card First Digits

payments_giftcardasdiscount

text

payments_giftcardcaption

text

[en] Gift Card Caption

payments_giftcardid

text

[en] Gift Card Id

payments_giftcardname

text

[en] Gift Card Name

payments_giftcardprovider

text

payments_group

text

[en] Payment Group. It represents the payment method.

payments_id

text

payments_installments

float

payments_koinurl

text

payments_lastdigits

text

[en] Payment Card Last Digits

payments_ns

text

payments_parentaccountid

text

payments_paymentsystem

text

payments_paymentsystemname

text

payments_redemptioncode

text

payments_referencevalue

float

payments_tid

text

payments_url

text

[en] Payment URL

payments_value

float

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] Rates and Benefits Name

orderid

text

[en] Order Seller Id

promotion_id

text

[en] The id of the promotion[Kondado]

matchedparameters_key

text

matchedparameters_val

text

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

promotion_id

text

[en] Promotion ID

activategiftsmultiplier

boolean

[en] If set as true, gifts Multiplier is activated.

aresaleschannelidsexclusive

boolean

[en] If set to false, this Promotion will be applied to any trade policies present on the idsSalesChannel field. If set to true, trade policies present on that field will make this Promotion or Tax not to be applied.

begindate

timestamp

[en] Promotion or Tax Begin Date

description

text

[en] Internal description of the Promotion or Tax.

enddate

timestamp

[en] Promotion or Tax End Date

hasmaxpriceperitem

boolean

isactive

boolean

[en] if set as true the Promotion is activated. If set as false the Promotion is deactivated.

isarchived

boolean

[en] If set as true the Promotion is archived. If set as false the Promotion is not archived.

istax

boolean

lastmodifiedutc

timestamp

maxusage

float

[en] Defines how many times the Promotion can be used.

name

text

[en] Promotion name or Tax name.

percentualtax

float

[en] Percentual Tax over purchase total value.

scope_allcatalog

boolean

scope_brands

float

[en] Object composed by the brands that will activate or deactivate the Promotion

scope_brandsareinclusive

boolean

[en] if set to true, this Promotion will be applied to any brand present on the brands field. If set to false, brands present on that field will make this Promotion not to be applied.

scope_categories

float

[en] Object composed by the categories that will activate or deactivate the Promotion

scope_categoriesareinclusive

boolean

[en] If set to true, this Promotion will be applied to any category present on the categories field. If set to false, categories present on that field will make this Promotion not to be applied.

scope_collections

float

[en] Object composed by the collections that will activate or deactivate the Promotion

scope_collectionsareinclusive

boolean

scope_products

float

[en] Object composed by the products that will activate or deactivate the Promotion

scope_productsareinclusive

boolean

[en] If set to true, this Promotion will be applied to any product present on the products field. If set to false, products present on that field will make this Promotion not to be applied.

scope_sellers

float

scope_sellersareinclusive

boolean

scope_skus

float

[en] Object composed by the SKUs that will activate or deactivate the Promotion

scope_skusareinclusive

boolean

[en] If set to true, this Promotion will be applied to any SKU present on the skus field. If set to false, SKUs present on that field will make this Promotion not to be applied.

status

text

type

text

[en] Defines what is the type of the promotion

utmcampain

text

utmsource

text

[en] Coupon utmSource code.

utmicampaign

text

promotion_id

text

[en] Promotion ID

campaigns_value

text

promotion_id

text

[en] Promotion ID

idssaleschannel_value

float

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

cubicweight

float

[en] Packaged Length

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

skuid

text

[en] SKU ID

video_url

text

[en] SKU video URL

sku_kit_id

float

[en] KIT SKU ID (parent)

    SKUs > > skuid

component_sku_id

float

[en] COMPONENT SKU ID (child)

    SKUs > > skuid

quantity

float

[en] Component quantity.

unitprice

float

[en] Component price per unit

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] SKU's suggested selling price.

markup

float

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

skuid

float

[en] SKU unique identifier number.

    SKUs > > skuid

daterange_from

timestamp

daterange_up_to

timestamp

fixedprices_listprice

float

[en] SKU List Fixed Price.

fixedprices_minquantity

float

[en] Minimum quantity of the SKU for the fixed price to be applied.

fixedprices_tradepolicyid

float

[en] Trade policy name or ID than have the fixed price configured.

fixedprices_value

float

[en] Fixed price value.