v50

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-29208421.4 MB
Supplier

Create supplier

Creates a new supplier.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:

ProductCategoryResource
Catalog APIGeneralEdit Product

There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

post/api/catalog/pvt/supplier

Headers

Content-Typestring required

Type of the content being sent.

Acceptstring required

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

Namestring required

Supplier Name.

CorporateNamestring required

Supplier Corporate Name.

StateInscriptionstring required

State Inscription.

Cnpjstring required

Corporate legal ID.

Phonestring required

Supplier Phone.

CellPhonestring required

Supplier Cellphone.

CorportePhonestring required

Supplier Corporate Phone.

Emailstring required

Supplier email.

IsActiveboolean required

Defines if the Supplier is active (true) or not (false).

Example request

{
  "Name": "Supplier",
  "CorporateName": "TopStore",
  "StateInscription": "123456",
  "Cnpj": "33304981001272",
  "Phone": "3333333333",
  "CellPhone": "4444444444",
  "CorportePhone": "5555555555",
  "Email": "email@email.com"
}

Response

OK

Idinteger

Supplier unique identifier code.

Namestring

Supplier name.

CorporateNamestring

Supplier corporate name.

StateInscriptionstring

State inscription.

Cnpjstring

Corporate legal ID.

Phonestring

Supplier phone.

CellPhonestring

Supplier cellphone.

CorportePhonestring

Supplier corporate phone.

Emailstring

Supplier email.

IsActiveboolean

Defines if the Supplier is active (true) or not (false).