Promotions > Coupons > couponsPage
Commerce APIPromotionsCouponscouponsPage
couponsPage
GET:coupons/page.json

Description

Get all promotion coupons.

See also: Pagination.

Permission bit: "coupons.read"

Topic: Coupons

Arguments

last_key: String

Key of the last item from previous page. See also: Pagination


limit: Int

Return up to N entries (pagination). See also: Pagination


offset: Int

Skip N entries (pagination). See also: Pagination


promotion_id: String!

Unique promotion identifier. See also: Unique Identifiers

Example: "pr_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: CouponsPageSortBy

Whether to sort output in some specific way. See also: Pagination


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


Result

CouponPage

Preview (typescript)

Loading module