GET:coupons.json
Commerce APIGET:coupons.json

GET:coupons.json

Description

Get one or multiple coupons by id.

This is a typical bulk get endpoint.

Permission bit: "coupons.read"

Topic: Coupons

Query Parameters

ids: Comma-separated array of String, required

List of coupon ids. See also: Unique Identifiers

Example: ?ids=cn_EQzGqWoY,cn_EQzGqWoY


loose: Boolean

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

Example: ?loose=true


promotion_id: String, required

Unique promotion identifier. See also: Unique Identifiers

Example: ?promotion_id=pr_EQzGqWoY


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

Response Body

Array of Coupon

Response Body Type

Loading module