PIpismo
Marketplace

List marketplaces V1 (deprecated)

List marketplaces using query parameters. This endpoint is deprecated. It is replaced by List marketplaces.

get/v1/marketplaces

Request

  • Base URL
    https://sandbox.pismolabs.io/marketplace
  • URL
    https://sandbox.pismolabs.io/marketplace/v1/marketplaces
  • Auth
    HTTP bearer

Query parameters

merchantnumber

Merchant ID. List all the marketplaces the merchant belongs to.

searchstring

If a value is provided for this field, the Pismo platform searches for that value in the document_number, registration, brand_name, and marketplace_name fields of the marketplace records. It also searches for it in the name and email fields of the contact object for each record.

For example, if the value provided is "acme", and a marketplace has marketplace_name = "The Acme Market", that record is returned. If another record has "acme" in the email field in it's contact object, that record is also returned.

pagenumber

Current page number

perPagenumber

Number of items per page

Headers

Authorizationstring

Authorization token. This is a regular access token, which does not need to include an account ID.

Content-Typestring

Content type

Response

OK

pagesinteger

Total number of pages

per_pageinteger

Number of result items per page

total_itemsinteger

Total number of items

current_pageinteger

Current page number

Example response

{
  "pages": 1,
  "per_page": 10,
  "total_items": 2,
  "current_page": 1,
  "items": [
    {
      "id": 1,
      "name": "Marketplace",
      "brand_name": "Marketplace",
      "document_number": "0123456789"
    },
    {
      "id": 2,
      "name": "Marketplace 2",
      "brand_name": "Marketplace 2",
      "document_number": "0123456788"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.