PIpismo
Marketplace

Get marketplace V2 (deprecated)

Get marketplace given its ID in the path. This endpoint is deprecated. It is replaced by Get marketplace.

get/v2/marketplaces/{marketplaceId}

Request

  • Base URL
    https://sandbox.pismolabs.io/marketplace
  • URL
    https://sandbox.pismolabs.io/marketplace/v2/marketplaces/{marketplaceId}
  • Auth
    HTTP bearer

Path parameters

marketplaceIdinteger required

Marketplace ID

Headers

Content-Typestring

Content type

Authorizationstring

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

Response

OK

brand_namestring

Marketplace brand name. A secondary name for the marketplace that is <b>not</b> the legal registered name.

document_numberstring

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

external_idstring

Marketplace ID used on client's system

idinteger

Marketplace ID

marketplace_namestring

Registered, legal marketplace name.

registrationstring

Municipal registration number. In some countries the municipal registration is called a business license.

registration2string

Additional municipal registration number. In some countries, two munipal registration numbers are required — one for the country and another for the state.

schedule_idinteger

Schedule ID for marketplace

Example response

{
  "id": 1,
  "schedule_id": 9,
  "document_number": "0123456789",
  "registration": "123.456.789",
  "registration2": "123.456.790",
  "brand_name": "Acme Market",
  "marketplace_name": "Acme Market, LLC",
  "external_id": "1123",
  "address": {
    "street": "Maple Avenue",
    "number": 22,
    "complementary_address": "Suite 2",
    "neighborhood": "West End",
    "zip_code": "12345-678",
    "city": "San Francisco",
    "state": "CA",
    "country": "United States"
  },
  "contact": {
    "name": "John Doe",
    "email": "email@email.com",
    "phone_number": "5558739452",
    "additional_phone_number": "5558739453"
  }
}

Changes

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