List marketplaces

Retrieve a paginated list of marketplaces with optional filtering and sorting capabilities.

Filtering

Filters are provided as individual query parameters. Multiple filters can be combined — each additional parameter further restricts the result set (AND logic).

ParameterField FilteredMatch TypeCase Sensitive
documentNumberdocument_numberExactYes
externalIdexternal_idExactYes
brandNamebrand_namePartial (LIKE)No
marketplaceNamemarketplace_namePartial (LIKE)No

Examples:

  • ?documentNumber=12345678901234 — exact document number match
  • ?brandName=Acme — brand name containing "Acme"
  • ?brandName=Acme&marketplaceName=Store — brand name containing "Acme" AND marketplace name containing "Store"

Sorting

Use order and orderBy to control result ordering. Supported orderBy values: marketplace_id, document_number, brand_name, marketplace_name, external_id. Default sort: marketplace_id ASC.

Empty Results

Empty result sets return HTTP 200 with an empty items array (not 404).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
≥ 1

Current page number

int32
≥ 1

Number of items per page

string
enum
Defaults to asc

Sort order direction (case-insensitive)

Allowed:
string
length ≤ 50

Field name to sort by. Supported fields:

  • marketplace_id
  • document_number
  • brand_name
  • marketplace_name
  • external_id
string
length between 1 and 14

Filter by marketplace document number (exact match, case-sensitive)

string
length between 1 and 50

Filter by external system identifier (exact match, case-sensitive)

string
length between 1 and 50

Filter by brand name (partial match, case-insensitive)

string
length between 1 and 100

Filter by marketplace name (partial match, case-insensitive)

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json