Promotions > Promotions > promotions
Commerce APIPromotionsPromotionspromotions
promotions
GET:promotions.json

Description

Get specific promotions.

Permission bit: "promotions.read"

Topic: Promotions

Arguments

flat: Boolean

Use flat output format instead of a recursive one


ids: [String!]!

List of promotion ids. See also: Unique Identifiers

Example: ["pr_EQzGqWoY"]


loose: Boolean

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


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Result

[Promotion!]

Preview (typescript)

function promotions(
flat?: boolean
ids: string[]
loose?: boolean
shop_id: string
): Promotion[]