Data Exchange APIPurchases

List purchases

View as Markdown

List purchases visible to the authenticated tenant, ordered by purchased_at descending. Use cursor pagination via since and limit.

Authentication

AuthorizationBearer

Production machine-to-machine flow. Tokens issued by Descope.

OR
AuthorizationBearer

Developer-exploration flow with PKCE. Used by Postman Guided Auth.

Query parameters

member_idstringOptional
Filter purchases to a single member.
plan_idstringOptional

Filter purchases to a single plan. Must be one of the plans the token is authorized for; otherwise the API returns 403 Forbidden.

ndcstringOptionalformat: "^\d{11}$"

Filter to a single NDC-11 drug code.

prescriber_spistringOptional

Filter to purchases written by a specific prescriber (Surescripts SPI).

event_typeenumOptional

Filter purchases to a single event type (e.g., only reversals).

statusenumOptional

Filter purchases by processing status (e.g., only rejected).

Allowed values:
sincestringOptional
Cursor or ISO 8601 UTC timestamp. Returns purchases after this point.
untildatetimeOptional

ISO 8601 UTC timestamp upper bound (exclusive).

limitintegerOptional1-1000Defaults to 100
Max results per page.

Response

A page of purchases.
datalist of objects
next_cursorstring or null

Pass as since to fetch the next page. Null when no more pages.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error