VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API legada/Referência completa/Catálogo do app do vendedor

Mix de produtos

Rotas de listas de mix de produtos (SKUs por seller e cliente) da Venddor 1.0, ainda sem implementação na plataforma atual.

Na Venddor 1.0, o módulo de mix de produtos permitia ao seller definir, para um cliente específico, uma lista própria de SKUs que ele pode comprar: um sortimento sob medida (por isso "mix"). A lista era identificada por três coisas: o seller (company_id), o cliente (user_id) e os códigos de produto (skus).

Ainda não implementado

As rotas existem e validam os parâmetros, mas não gravam nem leem nada. O GET devolve sempre uma lista vazia e o POST responde success: true com a mensagem Mix products service not yet implemented. 0 products added.. Não use como se a lista tivesse sido salva.

As rotas pedem usuário administrador (não seller) e existem sob dois nomes: mix_products e ecmixproducts (a grafia que o app antigo chama como EcMixProducts).

Use /api/v1.0

Na URL sem versão (/api/mix_products, /api/ecmixproducts), os ids do corpo e da consulta são trocados por UUID antes de chegar ao tratamento, que espera números inteiros: o GET responde company_id and user_id are required e o POST responde Invalid JSON body, mesmo com dados corretos. Só /api/v1.0/... funciona.

Consultar a lista

GET/api/v1.0/mix_productsAdmin

Consultar a lista de SKUs de um seller e cliente

Parâmetros de consulta

company_idintegerobrigatório
Id numérico do seller. Valor 0 ou ausente dá 400.
user_idintegerobrigatório
Id numérico do cliente. Valor 0 ou ausente dá 400.
GET/api/mix_productsAdmin

Alias de GET /api/v1.0/mix_products

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/mix_products. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

GET/api/v1.0/ecmixproductsAdmin

Alias de GET /api/v1.0/mix_products

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/mix_products.

GET/api/ecmixproductsAdmin

Alias de GET /api/v1.0/mix_products

Mesmo corpo, mesma resposta e mesmo comportamento de GET /api/v1.0/mix_products. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Gravar a lista

POST/api/v1.0/mix_productsAdmin

Adicionar SKUs à lista de um seller e cliente

Corpo da requisição

company_idintegerobrigatório
Id numérico do seller.
user_idintegerobrigatório
Id numérico do cliente.
skusarrayobrigatório
Códigos dos produtos (strings). Ao menos um.
POST/api/mix_productsAdmin

Alias de POST /api/v1.0/mix_products

Mesmo corpo, mesma resposta e mesmo comportamento de POST /api/v1.0/mix_products. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

POST/api/v1.0/ecmixproductsAdmin

Alias de POST /api/v1.0/mix_products

Mesmo corpo, mesma resposta e mesmo comportamento de POST /api/v1.0/mix_products.

POST/api/ecmixproductsAdmin

Alias de POST /api/v1.0/mix_products

Mesmo corpo, mesma resposta e mesmo comportamento de POST /api/v1.0/mix_products. Nesta URL (sem /v1.0), os ids de entidades usam o formato numérico legado.

Exemplo de requisição

Resposta

200Consulta
200Gravação (sem efeito)

Campos da resposta

successboolean
true quando os parâmetros são válidos. Não indica que algo foi gravado.
messagestring
Vazio na consulta; o aviso de não implementado na gravação.
skusarray
Na consulta, sempre [].

Erros

StatusQuandoCorpo
400GET sem company_id ou user_id{"message": "company_id and user_id are required", "status": 400}
400POST com JSON inválido{"message": "Invalid JSON body", "status": 400}
400POST sem skus{"message": "skus is required", "status": 400}
400POST sem company_id{"message": "company_id is required", "status": 400}
400POST sem user_id{"message": "user_id is required", "status": 400}
401Sem credencial ou credencial inválida{"message": "Authentication required. Use HTTP Basic with email:api_key or Bearer <jwt>.", "status": 401}
403Usuário que não é administrador{"message": "Forbidden: admin scope required", "status": 403}
Mesmo envelope das demais rotas de administração

Ao contrário das rotas do app do seller, estas respondem erros com o status HTTP verdadeiro (400, 401, 403) e o corpo {"message", "status"}.

Veja também

  • Visão geral do catálogo do app
  • Produtos
Anterior
Upload de arquivo
Próxima
Mídia do produto
Nesta página
  • Consultar a lista
  • Gravar a lista
  • Exemplo de requisição
  • Resposta
  • Erros
  • Veja também
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/v1.0/mix_products?company_id=1&user_id=2"

curl -u "$EMAIL:$API_KEY" -X POST "$BASE_URL/api/v1.0/mix_products" \
  -H "Content-Type: application/json" \
  -d '{"company_id":1,"user_id":2,"skus":["CAM-AZ-001","CAM-VM-002"]}'
json
{ "success": true, "message": "", "skus": [] }
json
{ "success": true, "message": "Mix products service not yet implemented. 0 products added." }