Skip to main content

CampaignItem

A product or product variant included in a campaign.

type CampaignItem {
  allocatedCount: Int!
  appliedCount: Int!
  campaignInventoryItems: [CampaignInventoryItem!]
  id: GlobalID!
  limit: Int
  reservedCount: Int!
  resource: CampaignItemResource!
}

Fields​

CampaignItem.allocatedCount ● Int! non-null scalar types​

The number of units allocated to campaign orders for the campaign item.

CampaignItem.appliedCount ● Int! non-null scalar types​

The number of units applied to the campaign item through inventory applications.

CampaignItem.campaignInventoryItems ● [CampaignInventoryItem!] list object types​

The campaign item's inventory items, one for each product variant that has been ordered.

CampaignItem.id ● GlobalID! non-null scalar types​

The campaign item's ID.

CampaignItem.limit ● Int scalar types​

The maximum number of units that can be sold for the campaign item. Only set when the campaign uses Submarine inventory tracking.

CampaignItem.reservedCount ● Int! non-null scalar types​

The number of units of the campaign item on active campaign orders.

CampaignItem.resource ● CampaignItemResource! non-null union types​

The product or product variant the campaign item covers.

Member Of​

CampaignInventoryItem object ● CampaignOrder object ● CrowdfundingCampaign object ● PresaleCampaign object