GET:promotions/page.json
Commerce APIGET:promotions/page.json

GET:promotions/page.json

Description

Get all promotions of a given shop.

See also: Pagination.

Permission bit: "promotions.read"

Topic: Promotions

Query Parameters

created_at_max: String

Filter output by creation date, upper boundary

Example: ?created_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)


created_at_min: String

Filter output by creation date, lower boundary

Example: ?created_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)


flat: Boolean

Use flat output format instead of a recursive one

Example: ?flat=true


last_key: String

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

Example: ?last_key=str


limit: Int

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

Example: ?limit=5


offset: Int

Skip N entries (pagination). See also: Pagination

Example: ?offset=5


shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY


sort_by: PromotionsPageSortBy

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

Example: ?sort_by=created_at


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination

Example: ?sort_desc=true


status: PromotionsPageStatus

Filter promotions output by status

Example: ?status=active


updated_at_max: String

Filter output by last update date, upper boundary

Example: ?updated_at_max=2014-09-04T12:23:34Z

Timestamp (RFC 3339)


updated_at_min: String

Filter output by last update date, lower boundary

Example: ?updated_at_min=2014-09-04T12:23:34Z

Timestamp (RFC 3339)

Response Body

PromotionPage

Response Body Type

Loading module