API legada/Referência completa/Vendedores

PUTAtualizar um vendedor

Altera os dados de um vendedor existente: nome da empresa, e-mail, métodos de envio e comissão.

Para atualizar um vendedor existente, envie uma requisição PUT para a URL do vendedor, com o ID da empresa no caminho. Inclua os dados do vendedor no corpo da requisição HTTP, de acordo com o Content-Type que você usar. Nenhum campo é obrigatório, então envie só o que quer alterar.

PUT/api/vendors/{company_id}Admin

Atualiza um vendedor existente

Parâmetros de caminho

company_idintegerobrigatório

O ID da empresa do vendedor a atualizar.

Corpo da requisição

companystring

Nome da empresa.

emailstring

Endereço de e-mail de contato.

shippingsobject

Métodos de envio disponíveis para este vendedor.

commissionstring

Valor da comissão.

commission_typestring

AP

Tipo da comissão: A para valor absoluto, P para percentual.

Exemplo de requisição

Esta requisição muda o nome da empresa para "Example", atualiza o e-mail para "test@example.com", habilita apenas o método de envio de ID 1 para este vendedor, define a comissão como 0 (sem comissão) e define o tipo de comissão como "A" (valor absoluto).

bash

curl -X PUT "$BASE_URL/api/vendors/2" \
  -u "$EMAIL:$API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "company": "Example",
  "email": "test@example.com",
  "shippings": {
    "1": "1"
  },
  "commission": "0",
  "commission_type": "A"
}'

Resposta

200Vendedor atualizado

json

{
  "store_id": "2"
}

Erros

Status	Descrição
`200 OK`	O vendedor foi atualizado com sucesso.
`400 Bad Request`	Parâmetros da requisição inválidos.
`404 Not Found`	Não existe vendedor com o ID informado.

Veja também