GET:products/page.json

Description

Get all products.

See also: Pagination.

Permission bit: "products.read"

Topic: Products

Query Parameters

brand_id: String

Filter output by brand

Example: ?brand_id=str

category_id: String

Filter output by product category

Example: ?category_id=str

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)

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

published_at_max: String

Filter output by publication date, upper boundary

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

Timestamp (RFC 3339)

published_at_min: String

Filter output by publication date, lower boundary

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

Timestamp (RFC 3339)

sales_channel_id: String

Filter output by sales channel

Example: ?sales_channel_id=str

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

sort_by: ProductsPageSortBy

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: PublishedStatus

Filter output by published status

Example: ?status=any

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

ProductPage

Response Body Type

Loading module