Discount APIs

Help merchants to offer flexible discounts and manage their marketting activity.

In this section

• AllDiscountItems — Whether all items in the cart are entitled to the discount.

• AutomaticDiscountSortKeys — The set of valid sort keys for the AutomaticDiscount query.

• CodeDiscountSortKeys — The set of valid sort keys for the CodeDiscount query.

• CustomerJourney — Represents a customer’s activity on a shop’s online store.

• CustomerJourneySummary — Represents a customer’s activity on a shop’s online store.

• CustomerMoment — An auto-generated type for paginating through multiple CustomerMoments.

• CustomerVisit — Information about a customer’s session on a shop’s online store.

• DiscountAmount — The fixed amount value of a discount.

• DiscountAmountInput — Specifies the value of the discount and how it is applied.

• DiscountAutomatic — An auto-generated type for paginating through multiple DiscountAutomatics.

• DiscountAutomaticBasic — An automatic basic discount.

• DiscountAutomaticBasicInput — Specifies input field to create or update automatic basic discount.

• DiscountAutomaticBxgy — An automatic BXGY discount.

• DiscountAutomaticBxgyInput — Specifies input field to create or update automatic bogo discount.

• DiscountAutomaticNode — An automatic discount wrapper node.

• DiscountCode — A code discount.

• DiscountCodeBasic — A basic code discount.

• DiscountCodeBasicInput — Specifies input field to create or update code basic discount.

• DiscountCodeBxgy — A BXGY code discount.

• DiscountCodeBxgyInput — Specifies input field to create or update a BXGY code discount.

• DiscountCodeFreeShipping — A free shipping code discount.

• DiscountCodeFreeShippingInput — Specifies input field to create or update free shipping code discount.

• DiscountCodeNode — A code discount wrapper node.

• DiscountCodeSortKeys — The set of valid sort keys for the DiscountCode query.

• DiscountCollections — A list of collections that the discount can have as a prerequisite or entitlement.

• DiscountCollectionsInput — Specifies the collections attached to a discount.

• DiscountCountries — The shipping destination where the discount applies.

• DiscountCountriesInput — Specifies a list of countries to add or remove from the free shipping discount.

• DiscountCountryAll — Whether the discount applies to all countries.

• DiscountCustomerAll — Whether the discount applies to all customers.

• DiscountCustomerBuys — The prerequisite items and prerequisite value.

• DiscountCustomerBuysInput — Specifies the prerequisite items and prerequisite quantity.

• DiscountCustomerBuysValue — The prerequisite quantity required for the discount to be applicable.

• DiscountCustomerBuysValueInput — Specifies the prerequisite quantity for the discount.

• DiscountCustomerGets — The qualifying items in an order, the quantity of each one, and the total value of the discount.

• DiscountCustomerGetsInput — Specifies the items that will be discounted, the quantity of items that will be discounted, and the value of discount.

• DiscountCustomerGetsValue — The value of the discount and how it will be applied.

• DiscountCustomerGetsValueInput — Specifies the quantity of items discounted and the discount value.

• DiscountCustomerSavedSearches — A list of customer saved searches that contain the customers to whom the discount applies.

• DiscountCustomerSavedSearchesInput — Specifies which customer saved searches to add to or remove from the discount.

• DiscountCustomerSelection — The selection of customers who can use this discount.

• DiscountCustomerSelectionInput — Specifies the customers who can use this discount.

• DiscountCustomers — A list of customers to whom the discount applies.

• DiscountCustomersInput — Specifies which customers to add to or remove from the discount.

• DiscountEffect — The type of discount that will be applied. Currently, only percentage off is supported.

• DiscountEffectInput — Specifies how the discount will be applied. Currently, only percentage off is supported.

• DiscountItems — Entitled or prerequisite items on a discount. An item could be either collection or product or product_variant.

• DiscountItemsInput — Specifies the items attached to a discount.

• DiscountMinimumQuantity — The minimum quantity of items required for the discount to apply.

• DiscountMinimumQuantityInput — Specifies the quantity minimum requirements for a discount.

• DiscountMinimumRequirement — The minimum subtotal or quantity requirements for the discount.

• DiscountMinimumRequirementInput — Specifies the quantity or subtotal minimum requirements for a discount.

• DiscountMinimumSubtotal — The minimum subtotal required for the discount to apply.

• DiscountMinimumSubtotalInput — Specifies the subtotal minimum requirements for a discount.

• DiscountOnQuantity — The quantity of items discounted, the discount value, and how the discount will be applied.

• DiscountOnQuantityInput — Specifies the quantity of items discounted and the discount value.

• DiscountPercentage — The percentage value of the discount.

• DiscountProducts — The entitled or prerequisite products and product variants for a discount.

• DiscountProductsInput — Specifies the products and product variants attached to a discount.

• DiscountPurchaseAmount — The prerequisite purchase amount required for the discount to be applicable.

• DiscountQuantity — The quantity of items in discount.

• DiscountRedeemCode — A redeem code for a code discount.

• DiscountShareableUrl — The shareable URL for the discount code.

• DiscountShareableUrlTargetType — The page type where shareable URL lands.

• DiscountShippingDestinationSelection — The selection of shipping countries to which this discount applies.

• DiscountShippingDestinationSelectionInput — Specifies the destinations where the free shipping discount will be applied.

• DiscountStatus — The status of the discount.

• KitSkillLocale — The locale language allowed for Kit Skill.

• MarketingActivity — A marketing activity represents marketing created by an app on behalf of the merchant.

• MarketingActivityBudgetInput — This type combines budget amount and its marketing budget type.

• MarketingActivityCreateInput — Specifies the input fields required to create a marketing activity.

• MarketingActivitySortKeys — The set of valid sort keys for the MarketingActivity query.

• MarketingActivityStatus — Status helps to identify if this marketing activity has been completed, queued, failed etc.

• MarketingActivityStatusBadgeType — StatusBadgeType helps to identify the color of the status badge.

• MarketingActivityUpdateInput — Specifies the input fields required to update a marketing activity.

• MarketingBudget — This type combines budget amount and its marketing budget type.

• MarketingBudgetBudgetType — The budget type for a marketing activity.

• MarketingChannel — The available marketing channels for a marketing activity or event. A marketing channel is broad category of marketing, used for reporting aggregation.

• MarketingEngagement — Marketing engagement represents customer activity taken on a marketing event.

• MarketingEngagementInput — This object represents marketing engagement input fields for a marketing engagement.

• MarketingEvent — Represents actions that market a merchant’s store or products.

• MarketingEventSortKeys — The set of valid sort keys for the MarketingEvent query.

• MarketingTactic — The available types of marketing event.

• PriceRule — Price rules are a set of conditions, including entitlements and prerequisites, that must be met in order for a discount code to apply.

• PriceRuleAllocationMethod — The method by which the price rule’s value is allocated to its entitled items.

• PriceRuleCustomerSelection — A selection of customers for whom the price rule applies.

• PriceRuleCustomerSelectionInput — Specifies the input fields to update a price rule customer selection.

• PriceRuleDiscountCode — A discount code of a price rule.

• PriceRuleDiscountCodeInput — Specifies the input fields to manipulate a discount code.

• PriceRuleEntitlementToPrerequisiteQuantityRatio — Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.

• PriceRuleEntitlementToPrerequisiteQuantityRatioInput — Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.

• PriceRuleFeature — A list of features used by the price rule.

• PriceRuleFixedAmountValue — The value of a fixed amount price rule.

• PriceRuleInput — Specifies the input fields to manipulate a price rule.

• PriceRuleItemEntitlements — The items to which this price rule applies. This may be multiple products, product variants, collections or combinations of the aforementioned.

• PriceRuleItemEntitlementsInput — Specifies the input fields to update a price rule line item entitlement.

• PriceRuleItemPrerequisitesInput — Specifies the input fields to update a price rule’s item prerequisites.

• PriceRuleLineItemPrerequisites — Single or multiple line item products, product variants or collections required for the price rule to be applicable, can also be provided in combination.

• PriceRuleMoneyRange — A money range within which the price rule is applicable.

• PriceRuleMoneyRangeInput — Specifies the input fields to update the money range within which the price rule is applicable.

• PriceRulePercentValue — The value of a percent price rule.

• PriceRulePrerequisiteToEntitlementQuantityRatio — Quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.

• PriceRulePrerequisiteToEntitlementQuantityRatioInput — Specifies the quantity of prerequisite items required for the price rule to be applicable, compared to quantity of entitled items.

• PriceRuleQuantityRange — A quantity range within which the price rule is applicable.

• PriceRuleQuantityRangeInput — Specifies the input fields to update the quantity range within which the price rule is applicable.

• PriceRuleShareableUrl — Shareable URL for the discount code associated with the price rule.

• PriceRuleShareableUrlTargetType — Page type where shareable URL lands.

• PriceRuleShippingEntitlementsInput — Specifies the input fields to update a price rule shipping entitlement.

• PriceRuleShippingLineEntitlements — The shipping lines to which the price rule applies to.

• PriceRuleSortKeys — The set of valid sort keys for the PriceRule query.

• PriceRuleStatus — The status of the price rule.

• PriceRuleTarget — The type of lines (line_item or shipping_line) to which the price rule applies.

• PriceRuleTrait — A list of features used by the price rule.

• PriceRuleValidityPeriod — A time period during which a price rule is applicable.

• PriceRuleValidityPeriodInput — Specifies the input fields to update the validity period of a price rule.

• PriceRuleValue — The value of the price rule.

• PriceRuleValueInput — Specifies the input fields to update a price rule.

• PricingPercentageValue — The value of the percentage pricing object.

• PricingValue — The value of the pricing object.

• UTMInput — Specifies the Urchin Traffic Module (UTM) parameters that are associated with a related marketing campaign.

• UTMParameters — Represents a set of UTM parameters.

• discountAutomaticActivate — Activates an automatic discount.

• discountAutomaticBasicCreate — Creates a basic automatic discount.

• discountAutomaticBasicUpdate — Updates a basic automatic discount using its ID and input.

• discountAutomaticBulkDelete — Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.

• discountAutomaticBxgyCreate — Creates a BXGY automatic discount.

• discountAutomaticBxgyUpdate — Updates a BXGY automatic discount using its ID and input.

• discountAutomaticDeactivate — Deactivates an automatic discount.

• discountAutomaticDelete — Deletes an automatic discount.

• discountCodeActivate — Activates a code discount.

• discountCodeBasicCreate — Creates a basic code discount.

• discountCodeBasicUpdate — Updates a basic code discount.

• discountCodeBulkActivate — Asynchronously activate code discounts in bulk using a search query, a savedSearchId or a list of IDs.

• discountCodeBulkDeactivate — Asynchronously deactivates code discounts in bulk using a search query, a savedSearchId or a list of IDs.

• discountCodeBulkDelete — Asynchronously delete code discounts in bulk using a search query, a savedSearchId or a list of IDs.

• discountCodeBxgyCreate — Creates a BXGY code discount.

• discountCodeBxgyUpdate — Updates a BXGY code discount.

• discountCodeDeactivate — Deactivates a code discount.

• discountCodeDelete — Deletes a code discount.

• discountCodeFreeShippingCreate — Creates a free shipping code discount.

• discountCodeFreeShippingUpdate — Updates a free shipping code discount.

• discountCodeRedeemCodeBulkDelete — Asynchronously delete discount redeem codes in bulk. Specify the redeem codes to delete by providing a search query, a savedSearchId, or a list of redeem code IDs.

• kitSkillTriggerRequest — Kit Skill requested by developer for app and shop.

• marketingActivityCreate — Create new marketing activity.

• marketingActivityUpdate — Updates a marketing activity.

• marketingEngagementCreate — Creates a new marketing event engagement for a marketing activity.

• priceRuleActivate — Activate a price rule.

• priceRuleCreate — Create a price rule using the input.

• priceRuleDeactivate — Deactivate a price rule.

• priceRuleDelete — Delete a price rule.

• priceRuleDiscountCodeCreate — Create a discount code for a price rule.

• priceRuleDiscountCodeUpdate — Update a discount code for a price rule.

• priceRuleUpdate — Update a price rule using its id and an input.