Add marketing data

Use this request to include marketing information to a given shopping cart.

The orderForm is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the orderFormId is the identification code of a given cart.

This request has a timeout of 12 seconds.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

Product	Category	Resource
Checkout	CheckoutResources	Read Shopping Cart

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

orderFormIdstring required

Example:ede846222cd44046ba6c638442c3505a

ID of the orderForm that will receive client profile information.

individualShippingEstimatesboolean

Example:true

Shows the product's estimated shipping date in the shippingEstimate field from the orderForm.

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

couponstring

Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the cart simulation request to check which coupons might apply before placing the order.

To send more than one coupon code to the same cart, use commas. E.g."sales25, blackfriday30".

marketingTagsstring[]

Marketing tags. Limited to a maximum of 50 items.

utmSourcestring

UTM source.

utmMediumstring

UTM medium.

utmCampaignstring

UTM campaign.

utmiPagestring

UTMI page (internal utm).

utmiPartstring

UTMI part (internal utm).

utmiCampaignstring

UTMI campaign (internal utm).

Example request

{
  "coupon": "free-shipping",
  "marketingTags": [
    "tag1",
    "tag2"
  ],
  "utmSource": "Facebook",
  "utmMedium": "CPC",
  "utmCampaign": "Black friday",
  "utmiPage": "utmi_page-example",
  "utmiPart": "utmi_part-exmaple",
  "utmiCampaign": "utmi_campaign-exmaple"
}

Response

OK

orderFormIdstring

ID of the orderForm corresponding to a specific cart.

salesChannelstring

Attribute created by the seller, in their VTEX store configuration.

loggedInboolean

Indicates whether the user is logged into the store.

isCheckedInboolean

Indicates whether order is checked in.

storeIdstring nullable

ID of the store.

allowManualPriceboolean

Permission to modify item price manually.

canEditDataboolean

Data can be edited.

userProfileIdstring nullable

Unique ID associated with the customer profile.

profileProviderstring

Profile provider.

availableAccountsstring[]

Available accounts.

userTypestring nullable

User type.

ignoreProfileDataboolean

Ignore customer profile data.

valueinteger

Total value of the order without separating cents. For example, $24.99 is represented as 2499.

messagesstring[]

Array containing an object for each message generated by our servers while processing the request.

selectableGiftsstring[]

Array containing the data of the item selected as a gift.

totalizersobject[]

Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).

commercialConditionDataobject nullable

Object containing commercial condition information.

storePreferencesDataobject

Object containing data from the store's configuration (stored in VTEX's License Manager).

giftRegistryDataobject nullable

Gift registry list information.

openTextFieldstring nullable

Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as JSON even if escaped. For that purpose, see Creating customizable fields.

hooksDataobject nullable

Hooks information.

subscriptionDataobject nullable

Subscription information.

v52

Add marketing data

Permissions

Path parameters

Query parameters

Headers

Request body

Example request

Response