PIpismo
Marketplace merchants links

List merchants linked to a marketplace

Returns information about the merchants linked to this marketplace

get/v1/marketplaces/{marketplaceId}/merchants

Request

  • Base URL
    https://sandbox.pismolabs.io/sellers
  • URL
    https://sandbox.pismolabs.io/sellers/v1/marketplaces/{marketplaceId}/merchants
  • Auth
    none declared

Path parameters

marketplaceIdinteger required

Marketplace ID

Query parameters

pageinteger
Example:1

Current page number

perPageinteger

Number of items per page

subnet'individual' | 'hq' | 'branch'

Filter by merchant subnet. Values are individual, hq (short for Headquarters), or branch.

A merchant is:

  • hq if it has branch merchants.
  • branch if it is another merchant's branch.
  • individual if it isn't a branch nor headquarters.

To create these relationships, use the Link marketplace to merchants endpoint.

hqIdinteger

Filter by merchant headquarters ID

branchIdinteger

Filter by merchant branch ID

Response

OK

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": [
    {
      "id": 24175
    }
  ],
  "page": 1,
  "per_page": 10
}

Changes

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