Skip to content

List Cart Rule Coupons

Lists every coupon code attached to one cart rule — the coupon table on the admin Marketing → Promotions → Cart Rules → Coupons screen.

TIP

New here? Read the Cart Rule Coupons overview for what a coupon does and how its fields behave.

Operation

OperationTypePurpose
adminMarketingCartRuleCouponsQueryCursor-paginated list of one cart rule's coupons

Details

  • Requires an admin Bearer token in the Authorization header.
  • This is a sub-resource of a cart rule — cartRuleId is required and scopes the list to that rule. Coupons from other rules never appear in the result.
  • An unknown cartRuleId returns a 404 error.
  • Cursor pagination — pass first for the page size and after (the endCursor from the previous page) to advance. totalCount is the grand total.

Arguments

ArgumentTypeRequiredNotes
cartRuleIdIntYesParent cart-rule id; scopes the list
firstIntNoPage size
afterStringNoCursor (endCursor from the previous page)

Released under the MIT License.