Search merchant data

Searches merchant data to return resources such as customers, invoices, orders, transactions.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
query Parameters
sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -. Multiple fields can be sorted by separating each with ,.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

q
string

Default search. Searches across resources and fields.

get
/search
Responses

200

Results keyed by a resource.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
Array of objects (Customer)

List of returned customers.

Array of objects (Invoice)

List of returned invoices.

Array of objects (SubscriptionOrOneTimeSale)

List of returned orders.

Array of objects (Transaction)

List of returned transactions.

searched
Array of strings

Names of searched resources. Includes all searched resources.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[ { } ]