Marketplace

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

get/v3/marketplaces

Request

  • Base URL
    https://sandbox.pismolabs.io/sellers
  • URL
    https://sandbox.pismolabs.io/sellers/v3/marketplaces
  • Auth
    none declared

Query parameters

pageinteger
Example:1

Current page number

perPageinteger

Number of items per page

order'asc' | 'desc'

Sort order direction (case-insensitive)

orderBystring

Field name to sort by. Supported fields:

  • marketplace_id
  • document_number
  • brand_name
  • marketplace_name
  • external_id
documentNumberstring

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

externalIdstring

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

brandNamestring

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

marketplaceNamestring

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

Response

OK - Paginated list of marketplaces

has_nextboolean required

Is a next page available?

pageinteger required

Current page number (starts at 1)

per_pageinteger required

Number of items per page

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.