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).
| Parameter | Field Filtered | Match Type | Case Sensitive |
|---|---|---|---|
| documentNumber | document_number | Exact | Yes |
| externalId | external_id | Exact | Yes |
| brandName | brand_name | Partial (LIKE) | No |
| marketplaceName | marketplace_name | Partial (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).
Request
- Base URLhttps://sandbox.pismolabs.io/sellers
- URLhttps://sandbox.pismolabs.io/sellers/v3/marketplaces
- Authnone declared
Query parameters
Current page number
Number of items per page
Sort order direction (case-insensitive)
Field name to sort by. Supported fields:
- marketplace_id
- document_number
- brand_name
- marketplace_name
- external_id
Filter by marketplace document number (exact match, case-sensitive)
Filter by external system identifier (exact match, case-sensitive)
Filter by brand name (partial match, case-insensitive)
Filter by marketplace name (partial match, case-insensitive)
Response
OK - Paginated list of marketplaces
Example response
{
"has_next": true,
"items": [
{
"brand_name": "Acme Corporation",
"document_number": "12345678901234",
"id": 51148,
"marketplace_name": "Acme Store",
"external_id": "EXT-123"
}
],
"page": 1,
"per_page": 10
}Changes
No recorded changes to this operation across all 1 revision of this API.