Discounts Allocator API reference
Extension targets
Anchor link to section titled "Extension targets"The Discounts Allocator API exposes the following targets:
| Target | Output type | Description |
|---|---|---|
purchase.discounts-allocator.run |
FunctionRunResult | Outputs a list of discounts allocations 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 Shipping Discount API's Input object accepts, refer to Input.
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.discounts-allocator.run target.
The following function result includes two line discounts: