Skip to content

Get a Supplier by supplierId

get
https://api.mercadoe.com/v1/suppliers/{supplierId}

Get information about a specific supplier with the given supplierId.

Request

Path Parameters

supplierId
int32
required

Responses

200
404
OK

Body

application/json
supplierId
int32
ME Supplier ID
clientSupplierId
string | null
Supplier code in the ERP
tradingName
string
Supplier’s trade name
companyName
string | null
Supplier’s company name
contact
string | null
Supplier contact name
address
string | null
Supplier address
city
string
Supplier city
addressNumber
string | null
Supplier’s address number
complement
string | null
Complement of the supplier’s address
neighborhood
string | null
Supplier neighborhood
state
string
Supplier state
country
string | null
Supplier country
postalCode
string | null
Supplier postal code
phoneNumber
string | null
Supplier phone number
email
string | null
Supplier email
languageId
int32 | null
Default language selection:
- 0 = Portuguese (BR)
- 1 = English
- 2 = Spanish
supplierGroup
string | null
Supplier Group
isDeactivated
boolean | null
Is the supplier deactivated/blocked? (True/False)
stateRegistrationNumber
string | null
Supplier state registration number
homologationStatus
string | null
Homologation Status
documents
array of object
Data related to the company national registration documents.
additionalEmails
array of object | null
Supplier additional email (separated by ;)