Inventory > Purchase Orders > purchaseOrdersPage
Commerce APIInventoryPurchase OrderspurchaseOrdersPage
purchaseOrdersPage
GET:purchase_orders/page.json

Description

Get all existing purchase orders.

See also: Pagination.

Permission bit: "purchase_orders.read"

Topic: Purchase Orders

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

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


sort_desc: Boolean

Whether to use descending sort order. See also: Pagination


supplier_id: String

Filter output by supplier


type: PurchaseOrderCategory

Filter purchase orders output by a purchase order type


Result

PurchaseOrderPage

Preview (typescript)

Loading module