The shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.

This guide will describe how to add marketing data information to the shopping cart via API. For more information about UTMs, read What are utm_source, utm_campaign, and utm_medium.

The first step is to get the orderFormId of the shopping cart to which you want to add the marketing information. For more information, read the Getting cart information by ID guide.

To add marketing information to the shopping cart, you need to use the Add marketing data endpoint. In this request, you must send the orderFormId through the URL address, as shown in the example below:

https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/marketingData

Additionally, you must send the request body containing the following marketing information:

• coupon: Coupon code to apply to the cart. Use the cart simulation request to check which coupons can be applied before placing the order.
• marketingTags: Marketing tags.
• utmSource: Traffic source (e.g. Facebook, Google).
• utmMedium: Advertising or marketing media (e.g. banner, CPC).
• utmCampaign: Campaign name (e.g. Christmas, launch, promo01).
• utmiPage: utmi_page (internal utm).
• utmiPart: utmi_part (internal utm).
• utmiCampaign: utmi_campaign (internal utm).

See a request body example below:

After sending the request, the endpoint will return the response body containing the client preferences information in the shopping cart, as in the example below:

️ For more information on the meaning of each field available in the shopping cart, see the orderForm overview.

The following errors may appear as a message in the response body.

Despite the code 200, which indicates the success of the request, if the coupon code sent is incorrect or unavailable, the following message will appear:

• Message error example (code ORD002): "Invalid order form". The orderFormId information is not valid.

• Message error example: "The requested URL was not found on the server": Check if the URL is correct.