Search merchant data

Request

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

Security
SecretApiKey or JWT
Query
sortArray 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 ,.

limitinteger, [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offsetinteger, [ 0 .. 1000 ]

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

qstring

Default search. Searches across resources and fields.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/search?sort=string&limit=1000&offset=1000&q=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Results keyed by a resource.

Headers
Pagination-Totalinteger

Total number of items.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

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
Bodyapplication/json
Array [
customersArray of objects(Customer)read-only

List of returned customers.

invoicesArray of objects(Invoice)read-only

List of returned invoices.

ordersArray of objects(SubscriptionOrOneTimeSale)read-only

List of returned orders.

transactionsArray of objects(Transaction)read-only

List of returned transactions.

searchedArray of stringsread-only

Names of searched resources. Includes all searched resources.

]
Response
[
  {
    "customers": [ … ],
    "invoices": [ … ],
    "orders": [ … ],
    "transactions": [ … ],
    "searched": [ … ]
  }
]