PIpismo
Marketplace

Update marketplace

This endpoint updates the marketplace information. This endpoint generates a <a href="https://developers.pismo.io/events/docs/marketplace-marketplace-updated-2">Marketplace updated</a> event.

patch/v1/marketplaces/{marketplaceId}

Request

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

Path parameters

marketplaceIdinteger required

Marketplace ID

Request body

marketplace_namestring

Registered, legal marketplace name

brand_namestring

Marketplace brand name. A secondary name for the marketplace that is not the legal registered name

document_numberstring

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

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

external_idstring

Marketplace ID used on client's system

Example request

{
  "marketplace_name": "Acme Products, LLC",
  "brand_name": "Acme",
  "document_number": "20166135000139",
  "registration": "123.456.789",
  "registration2": "123.456.790",
  "external_id": "1123",
  "address": {
    "number": 22,
    "street": "Maple Avenue",
    "complementary_address": "Suite 2",
    "neighborhood": "West End",
    "zip_code": "91941",
    "city": "San Diego",
    "state": "CA",
    "country": "United States"
  },
  "contact": {
    "name": "Jane Doe",
    "email": "email@email.com",
    "phone_number": "5558739452",
    "additional_phone_number": "5558739453"
  }
}

Response

Ok

idinteger

Marketplace ID

document_numberstring

Marketplace document number

brand_namestring

Marketplace brand name

marketplace_namestring

Marketplace name

registrationstring

Official company registration with the local municipality

registration2string

Complementary registration number issued by local authorities. In certain countries, businesses may be required to hold multiple municipal registrations at national, state, or regional levels.

external_idstring

Marketplace external identifier

Example response

{
  "id": 51148,
  "document_number": "12345678901234",
  "brand_name": "Tech Store Brasil",
  "marketplace_name": "TechStore Marketplace",
  "external_id": "EXT-MP-001",
  "address": {
    "street": "Rua das Flores, 123",
    "number": 123,
    "zip_code": "01234-567",
    "city": "São Paulo",
    "state": "SP",
    "country": "Brasil"
  },
  "contact": {
    "name": "João Silva",
    "email": "joao.silva@techstore.com",
    "phone_number": "+55 11 99999-9999",
    "additional_phone_number": "+55 11 88888-8888"
  }
}

Changes

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