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).

Language
Response
Click Try It! to start a request and see the response here!