Alterar loja
Altera dados e situação de um seller; só os campos enviados com valor mudam.
Altera os dados de um seller. É a forma de completar o endereço, trocar o nome ou o e-mail e aprovar ou suspender o seller mudando o status.
A alteração é parcial: só vale o que você manda com valor. Texto vazio ("") é tratado como "não enviado" e não limpa o campo, então esta rota não consegue apagar um telefone ou um endereço. Os campos company_* têm precedência sobre os de nome curto equivalentes.
/api/v1.0/stores/{id}AdminAlterar uma loja
Parâmetros de caminho
iduuidobrigatóriocompany_id por /api/v1.0. O id decimal que a forma /api/... devolve não é aceito aqui.Corpo da requisição
companystringcompany_name, que vale se os dois vierem).emailstringphonestringcompany_phone).urlstringcompany_website).addressstringcompany_address).citystringcompany_city).statestringcompany_state).countrystringcompany_country).zipcodestringcompany_zipcode).statusstringAPDRactivependingdisabledsuspendedrejectedA aprova e liga o seller, D suspende.storefrontstringslug não muda por aqui./api/stores/{id}AdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).
/api/v1.0/vendors/{id}AdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.
/api/vendors/{id}AdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).
/api/v1.0/companies/{id}AdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele.
/api/companies/{id}AdminMesma operação, caminho alternativo
Mesmo comportamento, parâmetros e resposta de PUT /api/v1.0/stores/{id}. Use este caminho se o seu cliente já foi escrito para ele. Na forma sem versão (/api/...) os ids saem como números decimais em string, mas os caminhos só aceitam o UUID (veja a home da seção).
Exemplo de requisição
curl -X PUT "$BASE_URL/api/v1.0/stores/3b617148-8a28-4d07-8040-a8903b4238d6" \
-u "$EMAIL:$API_KEY" \
-H "Content-Type: application/json" \
-d '{
"company_name": "Moda Aurora S.A.",
"status": "A",
"address": "Rua Augusta, 1234",
"company_phone": "(11) 3333-4444"
}'Resposta
{ "store_id": "3b617148-8a28-4d07-8040-a8903b4238d6" }Campos da resposta
store_idstringErros
| Status | Quando | Corpo de exemplo |
|---|---|---|
| 401 | Sem credencial. | {"status":401,"message":"Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>."} |
| 401 | E-mail ou chave de API inválidos. | {"status":401,"message":"Invalid credentials"} |
| 403 | A credencial é válida, mas o usuário não é administrador. | {"status":403,"message":"Forbidden: admin scope required"} |
| 404 | Nenhuma loja com esse UUID, ou a loja já foi excluída. | {"status":404,"message":"store not found"} |
| 400 | Corpo que não é JSON. | {"status":400,"message":"invalid request body"} |
| 400 | status com texto desconhecido, ou {id} que não tem formato de UUID (por exemplo o id decimal da forma /api). | {"status":400,"message":"..."} (mensagem interna de erro, não estável) |