Create a Supplier
post
https://api.mercadoe.com/v1/suppliers
Create a new supplier by providing the trading name, city, documents related to company national registration, and other details.
Request
Headers
X-ME-CORRELATION-ID
string
Internal client code to be identified in the webhook. It can be, for example, a product code in your ERP, an order number, etc.
Body
application/json
clientSupplierId
string
Supplier code in the ERP
tradingName
string
required
Supplier’s trade name
companyName
string
required
Supplier’s company name
contact
string
required
Supplier contact name
address
string
required
Supplier address
city
string
required
Supplier city
state
string
required
Supplier state
country
string
required
Supplier country
addressNumber
string
required
Supplier’s address number
neighborhood
string
required
Supplier neighborhood
complement
string | null
Complement of the supplier’s address
postalCode
string
required
Supplier postal code
phoneNumber
string
required
Supplier phone number
email
string
required
Supplier email
stateRegistrationNumber
string
Supplier state registration number
languageId
int32 | null
Default language selection:
- 0 = Portuguese (BR)
- 1 = English
- 2 = Spanish
- 0 = Portuguese (BR)
- 1 = English
- 2 = Spanish
supplierGroup
string
deprecated
Supplier Group
isDeactivated
boolean | null
Is the supplier deactivated/blocked? (True/False)
additionalEmails
array of object
Supplier additional email
document
object
required
attributes
array of object | null
Attributes of the supplier, consisting of a name and a value.
accounts
array of object | null
Supplier’s bank accounts
homologationStatus
string | null
Homologation Status
groups
array of object | null
List with the relationships between the group and the supplier
Responses
202
400
Accepted
Body
application/json
correlationId
string