List receipts for a purchase order
GET/v1/entities/:entity_id/purchase_orders/:purchase_order_uuid/receipts
Returns the committed receipts recorded against one purchase order. API keys only see
committed receipts; asking for any other status returns 403. A purchase_order_uuid that
is not one of your purchase orders, or belongs to a deleted one, returns 404. A purchase order with no
committed receipts returns an empty list, even when its status is received: its receipts
appear once their stock update in Shopify has finished.
Requires the purchase_order_receipts:read scope.
The response is a plain JSON object. The root key is purchase_order_receipts; pagination
lives in meta (page, per_page, total).
Request
Responses
- 200
- 401
- 403
- 404
- 429
- 504
A page of receipts.
The Authorization header is missing, is not HTTP Basic, or does not carry a valid API key. Create and manage keys under Settings → API keys in the Bookkeep section of the Bookkeep app.
The key does not hold purchase_order_receipts:read, or the key's store is not linked to {entity_id}.
No purchase order with that uuid for the key's store, or it has been deleted.
Rate limit reached. The inventory endpoints share one limit of 60 requests per minute per source IP address, counted across Purchase Orders, Suppliers, Receipts and Bills. The count resets at the start of each minute. No Retry-After header is sent. The body is JSON only when the request sends Accept: application/json; otherwise it is an HTML page.
The service did not respond in time. This is a read, so it is safe to retry after a short wait.