Skip to content

Update a supplier based on the supplierId

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

Change a specific supplier field with a provided value.

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.

Path Parameters

supplierId
int32
required
the supplier id

Body

application/json
contact
string
Supplier contact name
phone
string
deprecated
Supplier phone number
email
string
Supplier email
clientSupplierId
string
Supplier code in the ERP
isDeactivated
boolean | null
Is the supplier deactivated/blocked? (True/False)
additionalEmails
array of object | null
Supplier additional email
attributes
array of object | null
Attributes of the supplier, consisting of a name and a value.
tradingName
string | null
Supplier’s trade name
companyName
string | null
Supplier’s company name
address
string | null
Supplier address
city
string | null
Supplier city
state
string | null
Supplier state
country
string | null
Supplier country
addressNumber
string | null
Supplier’s address number
neighborhood
string | null
Supplier neighborhood
complement
string | null
Complement of the supplier’s address
postalCode
string | null
Supplier postal code
phoneNumber
string | null
Supplier phone number
stateRegistrationNumber
string | null
Supplier state registration number
languageId
int32 | null
Default language selection:
- 0 = Portuguese (BR)
- 1 = English
- 2 = Spanish
supplierGroup
string | null
deprecated
Supplier group
homologationStatus
string | null
Homologation Status
document
object
groups
array of object | null
List with the relationships between the group and the supplier
accounts
array of object | null
Supplier’s bank accounts

Responses

202
400
404
Accepted

Body

application/json
correlationId
string