Promotions > Coupons > coupons
Commerce APIPromotionsCouponscoupons
coupons
GET:coupons.json

Description

Get one or multiple coupons by id.

This is a typical bulk get endpoint.

Permission bit: "coupons.read"

Topic: Coupons

Arguments

ids: [String!]!

List of coupon ids. See also: Unique Identifiers


loose: Boolean

When asking for multiple items, allow returning less than was asked (in case some are missing)


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"


Result

[Coupon!]

Preview (typescript)

Loading module