List purchases

get

https://api.mobilize.io/v1.1/commerce/purchases

Returns a paginated list of purchases, each with an abbreviated product and user carrying all
of their mapped External IDs.

Every filter is optional and all of them combine. fulfillment_status reflects what Journey
by Forj has actually processed, so this operation is how a caller confirms that an
asynchronous fulfillment or cancellation has completed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

int32

1 to 100

Defaults to 25

Maximum number of purchases to return. Defaults to 25, capped at 100.

offset

int32

≥ 0

Defaults to 0

Number of purchases to skip before the current page. Defaults to 0.

user_id

One of the following:

The integer uniquely associated with a user
|
A pair consisting of an External ID Namespace and an External ID, separated by a : character.
The Namespace component may not contain the characters : or /.

product_id

Return only purchases of this product.

One of the following:

The uuid uniquely associated with a product
|
A pair consisting of an External ID Namespace and an External ID, separated by a : character.
The Namespace component may not contain the characters : or /.

external_id_namespace

string

^[^:/]+$

Return only purchases whose product or user has an External ID mapped in this namespace.

fulfillment_status

string

enum

Return only purchases with this fulfillment status.

Allowed:

entitlement_status

string

enum

Return only purchases whose entitlement is in this state. Evaluated when the request
is served, so a purchase moves between pending, active, and expired over time
without being modified.

Purchases with no entitlement match no value of this filter, so supplying it excludes
everything that is not yet fulfilled.

Allowed:

purchased_before

date-time

Return only purchases made before this time.

purchased_after

date-time

Return only purchases made after this time.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400There was a problem with the request. Refer to the response body for details.

401Credentials were missing from the request or were not valid.

429The rate limit of 100 requests per minute per source IP address was exceeded. Enforced at the load balancer ahead of the application; the response has no body.