Get Order Approvals

Returns a list of order approvals in the library.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Requires the Approve Orders permission, and the library must have the Order Approval module.

No status filter is applied by default. To fetch only the approvals still waiting for a decision, filter on status=pending.

One purchase order can have several order approvals. When a rejected order is edited and sent again, it gets a new order approval and the rejected one stays rejected, so the same order can appear on more than one row.

To find the order approval for an order that Send Purchase Order parked, filter on status=pending and on the outlet and supplier IDs of that order, then take the row whose purchase_order.id is the order's id. An order has at most one pending approval. Like every call in this section, this needs the Approve Orders permission, so it is for whoever will decide on the order.

Query Params
integer

Page number.

integer

Results per page. Default 10, maximum 200.

string
enum

Only return approvals in this state.

Allowed:
string

Only return approvals for orders of this outlet ID.

string

Only return approvals for orders to this supplier ID.

string

Only return approvals sent for approval by this user ID.

date

Only return approvals sent for approval on this date (YYYY-MM-DD).

date

Only return approvals sent for approval after this date (YYYY-MM-DD).

date

Only return approvals sent for approval before this date (YYYY-MM-DD).

string

Sort keys, comma-separated: status, outlet (by outlet name), submitted_at, order_amount_at_submit, expected_delivery_date. Prefix a key with - for descending order. Unknown keys are ignored.

Responses

403

The library does not have the Ordering or the Order Approval module, the token lacks the procurement scope, or the user lacks the Approve Orders permission.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json