List Purchase Receives

Lists purchase receives (deliveries of stock) for a location in minimal form, newest first. Pass the literal all as the id to list receives across every location. Includes both receives recorded against a purchase order (purchase set) and direct stock receives (purchase null). Ordering is fixed — order_by is not supported on this list. Requires the read-purchase-orders permission at the location (company-wide for all).

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

Location id, or the literal all for every location.

Query Params
integer
Defaults to 1

Page number.

integer
Defaults to 20

Rows per page.

integer
enum

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

Allowed:
string

Filter by receive number (partial match), e.g. PR/00002.

string

Filter by exact supplier name (no partial matching on this list).

string

Filter by location name.

string

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

Headers
string
required

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

Response

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