Merchant

List merchants

Find merchants using query parameters.

For more information about merchants, see the <a href="https://developers.pismo.io/pismo-docs/docs/seller-management-overview" target="blank">Seller management overview</a> guide.

get/v1/merchants

Request

Base URL
https://sandbox.pismolabs.io/merchants
URL
https://sandbox.pismolabs.io/merchants/v1/merchants
Auth
HTTP bearer

Query parameters

documentNumberstring

Example:73399909000114

Merchant document number

statusstring

Example:ACTIVE

Merchant status. This is a string, not an enum, so any string value is allowed, but the most commonly used values are: 'ACTIVE', 'ANALYSING', 'APPROVED', 'CANCELLED', 'PENDING', 'REJECTED'

namestring

Example:Acme Store

Merchant name

externalIdstring

Example:5321

ID used by client to reference a merchant in their domain.

pageinteger

Example:1

Page number. Default is 1.

perPageinteger

Example:10

Items per page. Default is 10.

Headers

Authorizationstring

Example:Bearer 1JI12J39182H39182JDIOAWJ%=

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

x-marketplace-idinteger

Example:123456

Marketplace ID

Response

idinteger

Merchant ID

document_numberstring

Merchant document number. This is the government document code, such as a government-issued tax ID.

municipal_registrationstring

Merchant's municipal registration number

contactstring

Name of contact

emailstring

Email address

zip_codestring

Postal code. This is called a zip code in the United States, but you can use other types of postal codes.

addressstring

Name of the street, avenue, or primary thoroughfare of the address

complementary_addressstring

Additional address details that help pinpoint the exact location, such as building, apartment, or floor

neighborhoodstring

Name of the neighborhood or administrative region where the address is located

statestring

Abbreviation or full name of the state, province, or administrative division

citystring

Name of the city or municipality

city_codestring

Official seven-digit numeric code of the city according to the IBGE (Brazilian Institute of Geography and Statistics) code table. Used only for cities in Brazil; this code is unique per city.

countrystring

Full name of the country according to international standards or local registry

numberinteger

Numerical identifier for the specific location within a street or avenue

area_codestring

Area code. The US, Canada, and certain other countries divide their telephone service into regions, which are identified by numbers called area codes. In the US, for example, area codes are 3-digit numbers.

phonestring

Phone number. Parentheses and dashes are optional.

additional_area_codestring

Additional area code (for additional_phone)

additional_phonestring

Number for an additional phone. Parentheses and dashes are optional.

marketplace_categorynumber

Marketplace category ID. The category is the type of business.

statusstring

Merchant status. This is a string, not an enum, so any string value is allowed, but the most commonly used values are: 'ACTIVE', 'ANALYSING', 'APPROVED', 'CANCELLED', 'PENDING', 'REJECTED'

program_idinteger

Program ID for merchant account

external_idstring

Internal ID used by client to reference a merchant in their domain.

creditor_idinteger

Creditor ID

namestring

Merchant brand name. Note that this is different from a merchant's legal registered name. For example, <i>Great Company</i> as opposed to <i>Great Company, LLC</i> (legal entity name).

merchant_namestring

Merchant name

Example response

{
  "id": 9278,
  "document_number": "40533164000107",
  "name": "Pismo Store",
  "merchant_name": "Pismo Store",
  "municipal_registration": "737.326.648.860",
  "category": "abc-123",
  "contact": "John Doe",
  "email": "store@pismo.com",
  "zip_code": "12345",
  "address": "Maple Street",
  "complementary_address": "Suite 100",
  "neighborhood": "Canary Wharf",
  "state": "CA",
  "city": "San Diego",
  "country": "United States",
  "number": 223,
  "area_code": "555",
  "phone": "1231234",
  "additional_area_code": "555",
  "additional_phone": "1231234",
  "marketplace_category": 1,
  "status": "ANALYSING",
  "program_id": 123,
  "external_id": "3254",
  "creditor_id": 123,
  "city_code": 3550308,
  "business_category": {
    "category": "Management, consulting, and public relations services",
    "description": "Management, consulting, and public relations services",
    "external_code": "123"
  }
}

Changes

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