List purchase orders

get

https://api.smoothpos.net/purchaseorders.json

Returns your purchase orders with their lines, 50 at a time by default. Page through them with the X-Next-Page header.

See Filtering, sorting and search for how the filters, ranges and sort work.

Required permission (any one of these):

Group	Permission
Purchasing	List and view purchase orders
Purchasing	Create, edit and delete purchase orders (includes view)

Query Params

limit

integer

1 to 250

Defaults to 50

How many records to return per page. Defaults to 50, maximum 250.

cursor

string

Opaque paging cursor. Don't build this yourself: follow the path in the X-Next-Page or X-Prev-Page response header.

since_id

integer

Only return purchase orders with an ID greater than or equal to this one. Note that this one is inclusive: the record with this ID is returned too.

number

string

Exact match on number.

number_min

date-time

Greater than (not including) the number.

number_max

date-time

Less than (not including) the number.

supplier

string

Exact match on supplier_id.

string

Partial match on number.

ids

string

^\d+(,\d+)*$

Matches one ids or a comma-separated list (up to 200).

supplier_id

string

^\d+(,\d+)*$

Matches one supplier id or a comma-separated list (up to 200).

expected_delivery_from

string

From this expected delivery. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

expected_delivery_to

string

Up to this expected delivery. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

actual_delivery_from

string

From this actual delivery. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

actual_delivery_to

string

Up to this actual delivery. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_from

string

From this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

created_to

string

Up to this created. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_from

string

From this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

updated_to

string

Up to this updated. Accepts YYYY-MM-DD (a _to date covers the whole day) or a full timestamp (RFC 3339, converted to UTC). Inclusive.

sort

string

Sort order. Use sort=key for ascending or sort=-key for descending, for example sort=-created. Keys: id, number, expected_delivery_date, actual_delivery_date, supplierid, created, updated. The older sort_field=key&sort=asc|desc style still works.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200Success.

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: not authorised