Source Gift

{
  description: "Get a free gift when you spend $100 or more",
  id: "gift-1",
  isMaxItemsAdded: false,
  isMet: true,
  itemsInCart: [
    "gid://shopify/ProductVariant/123",
  ],
  productId: "gid://shopify/Product/123",
  products: [
    {
      id: "gid://shopify/Product/123",
      variantId: "gid://shopify/ProductVariant/456",
    },
  ],
  title: "Free Gift with Purchase",
  totalUnitsInCart: 1,
  type: "auto",
  variantId: "gid://shopify/ProductVariant/456",
}

Properties
string

Collection ID
Available for choice gifts that use a collection

string

Description of the gift promotion

string

Unique identifier for the gift

boolean

Whether the maximum number of items has been added

boolean

Whether the conditions for the gift are met

array

Array of variant IDs from this gift in the cart

number

Maximum number of items that can be selected
Available for choice gifts

string

Product ID
Available for auto gifts with one product or choice gifts that use a product

array

All the available gift products
Available for auto gifts with multiple products

string

Title of the gift promotion

number

Total number of units of this gift in the cart.

string

Type of the gift (auto or choice)

string

Product variant ID
Available for auto gifts with one product