GET:purchase_orders/page.json

Description

Get all existing purchase orders.

See also: Pagination.

Permission bit: "purchase_orders.read"

Topic: Purchase Orders

Query Parameters

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

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

supplier_id: String

Filter output by supplier

Example: ?supplier_id=str

type: PurchaseOrderCategory

Filter purchase orders output by a purchase order type

Example: ?type=any

Response Body

PurchaseOrderPage

Response Body Type

Loading module