List Purchase Orders

get

https://api.ewitypos.com/apps-v1/purchases/location/{id}

Lists purchase orders for a location in minimal form, newest first by default. Pass the literal all as the id to list purchase orders across every location. Requires the read-purchase-orders permission at the location (company-wide for all). The search block in the response describes the supported q_* filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Location id, or the literal all for every location.

Query Params

page

integer

Defaults to 1

Page number.

limit

integer

Defaults to 20

Rows per page.

no_paginate

integer

enum

Send no_paginate=1 to return every matching row; the pagination object is omitted.

Allowed:

order_by

string

Sort field, optionally with a direction: field or field:asc / field:desc (bare field means descending). Allowed fields: id, number, location (location name), supplier (supplier name), created_at, updated_at. Any other field fails with 400 Invalid order field. Default ordering is id:desc.

q_number

string

Filter by exact PO number, e.g. PO/007 (no partial matching).

q_supplier_name

string

Filter by supplier name (partial match).

q_location

string

Filter by location name.

q_approved_date

string

Filter by approval date range: YYYY-MM-DD,YYYY-MM-DD (inclusive, company timezone).

q_due_date

string

Filter by due date range: YYYY-MM-DD,YYYY-MM-DD (inclusive, company timezone).

q_status

string

enum

Filter by status. closed is displayed as "Received" in the UI.

Allowed:

Headers

X-Ewity-Store

string

required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated purchase orders for the location.