Product Discount API reference
The Product Discount API enables you to create a new type of discount that is applied to particular product variants or cart lines.
Extension targets
Anchor link to section titled "Extension targets"The Product Discount API exposes the following targets:
| Target | Output type | Description |
|---|---|---|
purchase.product-discount.run |
FunctionRunResult | Outputs the product-level discount that should be applied to the cart |
The RunInput object is the complete schema that your function can receive as input.
For a list of fields that the Product Discount API's Input object accepts, refer to Input.
Input Example
Anchor link to section titled "Input Example"The following example shows an input query:
The following example shows the resulting input to the query:
FunctionRunResult
Anchor link to section titled "FunctionRunResult"The FunctionRunResult object is the expected output for the purchase.product-discount.run target.
Each Discount returned in the output can have a collection of either ProductVariantTargets or CartLineTargets, but not both.
Output Example
Anchor link to section titled "Output Example"The following FunctionRunResult includes a discount of 20% off for each cart line that has the targeted product variant ID: