Returns > Returns > returnsPage
Commerce APIReturnsReturnsreturnsPage
returnsPage
GET:returns/page.json

Description

Get all returns.

See also: Pagination.

Permission bit: "returns.read"

Topic: Returns

Arguments

last_key: String

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


limit: Int

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


offset: Int

Skip N entries (pagination). See also: Pagination


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


sort_by: ReturnsPageSortBy

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


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


type: ReturnCategory

Filter return output by a return type


Result

ReturnPage

Preview (typescript)

Loading module