docs
  1. Admin Api
  2. Resources
  3. Merchants
  4. List Merchants

List merchants

Get merchants for given filters

Rate Limit: 1000 Max attempts within 1 minute.

Query Parameters

ParameterDetails
limit
  • Minimum: 1
  • Maximum: 1000
integer
Default:
100
filters[minId]
integer
filters[maxId]
integer
sort
string
Enum:
id
Default:
id
sortDir
string
Enum:
asc
desc
Default:
asc
cursor
string
with
Array of strings
Example:
?with=contacts
string
Enum:
contacts
returnAddresses
carriers
warehouses

Responses

200
List of merchants
application/json
Success
Array of object
object
400
Bad Request
application/json
Error
401
Unauthorized
application/json
Error
GET/merchants

Request samples

Response samples

200
Collection of Merchants:
Content type: application/json
Provide Feedback