VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/Produtos do seller

Anexos do produto

Lista, anexa e reordena os arquivos para download de um produto do seller.

Anexos são arquivos que o cliente pode baixar na página do produto. Editar ou remover um anexo existente usa PUT e DELETE em /api/v1/vendor/attachments/{attachmentId}, rotas fora do caminho do produto que conferem se o anexo é de um produto seu.

Listar anexos

GET/api/v1/vendor/products/{id}/attachmentsSeller

Listar os anexos

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório
Id do produto.

Exemplo de requisição (listar)

bash
curl "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/attachments" \
  -H "Authorization: Bearer $TOKEN"

Resposta (listar)

200Anexos
json
{
  "items": [
    {
      "id": "3c1f9b2a-7d44-4e0b-8a6c-2b9d5e7f1a33",
      "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
      "file_name": "manual.pdf",
      "file_url": "/uploads/dfe2555e/produtos/manual.pdf",
      "file_size": 482113,
      "mime_type": "application/pdf",
      "description": "Manual de uso",
      "position": 0,
      "download_count": 0,
      "created_at": "2026-10-11T21:10:00Z",
      "updated_at": "2026-10-11T21:10:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

itemsarray
Anexos em ordem de posição.
totalinteger
Quantidade.

Erros (listar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}
403O produto existe mas é de outro seller (ou da loja).{"error":"you do not have access to this product"}
404Produto não existe.{"error":"product not found"}

Anexar arquivo

Registra um arquivo para download na página do produto, como manual, ficha técnica ou certificado. A plataforma guarda os dados que você informa; ela não valida o arquivo apontado por file_url.

POST/api/v1/vendor/products/{id}/attachmentsSeller

Anexar um arquivo

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório
Id do produto.

Corpo da requisição

file_namestringobrigatório
Nome exibido ao cliente.
file_urlstringobrigatório
URL do arquivo (por exemplo um caminho /uploads/... já enviado à loja).
file_sizeinteger
Tamanho em bytes.
mime_typestring
Tipo do arquivo, como application/pdf.
descriptionstring
Descrição curta.
positioninteger
Posição na lista.

Exemplo de requisição (anexar)

bash
curl -X POST "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/attachments" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "file_name": "manual.pdf",
  "file_url": "/uploads/dfe2555e/produtos/manual.pdf",
  "file_size": 482113,
  "mime_type": "application/pdf",
  "description": "Manual de uso"
}'

Resposta (anexar)

201Anexo criado
json
{
  "id": "3c1f9b2a-7d44-4e0b-8a6c-2b9d5e7f1a33",
  "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
  "file_name": "manual.pdf",
  "file_url": "/uploads/dfe2555e/produtos/manual.pdf",
  "file_size": 482113,
  "mime_type": "application/pdf",
  "description": "Manual de uso",
  "position": 0,
  "download_count": 0,
  "created_at": "2026-10-11T21:10:00Z",
  "updated_at": "2026-10-11T21:10:00Z"
}

Campos da resposta

idstring (uuid)
Id do anexo.
product_idstring (uuid)
Produto dono.
file_namestring
Nome exibido.
file_urlstring
URL do arquivo.
file_sizeinteger
Tamanho em bytes, informado por você.
mime_typestring
Tipo do arquivo, informado por você.
descriptionstring
Descrição.
positioninteger
Ordem na lista.
download_countinteger
Quantas vezes foi baixado.
created_atstring
Criação (RFC 3339).
updated_atstring
Última alteração (RFC 3339).

Erros (anexar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}
400file_name ou file_url ausentes.{"error":"file_name is required"}
403O produto existe mas é de outro seller (ou da loja).{"error":"you do not have access to this product"}
404Produto não existe.{"error":"product not found"}

Reordenar anexos

PUT/api/v1/vendor/products/{id}/attachments/reorderSeller

Reordenar os anexos

Cabeçalhos

Authorizationstringobrigatório
Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

idstring (uuid)obrigatório
Id do produto.

Corpo da requisição

attachment_idsarray of stringobrigatório
Ids dos anexos na ordem desejada.

Exemplo de requisição (reordenar)

bash
curl -X PUT "$BASE_URL/api/v1/vendor/products/$PRODUCT_ID/attachments/reorder" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "attachment_ids": [
    "3c1f9b2a-7d44-4e0b-8a6c-2b9d5e7f1a33"
  ]
}'

Resposta (reordenar)

200Anexos reordenados
json
{
  "items": [
    {
      "id": "3c1f9b2a-7d44-4e0b-8a6c-2b9d5e7f1a33",
      "product_id": "7bc1d5e9-a9a4-457b-866f-bbb3879d258d",
      "file_name": "manual.pdf",
      "file_url": "/uploads/dfe2555e/produtos/manual.pdf",
      "file_size": 482113,
      "mime_type": "application/pdf",
      "description": "Manual de uso",
      "position": 0,
      "download_count": 0,
      "created_at": "2026-10-11T21:10:00Z",
      "updated_at": "2026-10-11T21:10:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

itemsarray
Anexos na nova ordem.
totalinteger
Quantidade.

Erros (reordenar)

StatusQuandoCorpo
401Token ausente, inválido ou expirado.{"error":"missing authorization header"}
403Token que não é de seller, ou usuário sem o privilégio exigido pela rota.{"error":"insufficient vendor privileges","privilege_required_any":["vendor_catalog"]}
400attachment_ids ausente ou vazio.{"error":"attachment_ids is required"}
403O produto existe mas é de outro seller (ou da loja).{"error":"you do not have access to this product"}
404Produto não existe.{"error":"product not found"}

Veja também

  • Produtos do seller: visão geral
Anterior
Vídeos do produto
Próxima
Características do produto
Nesta página
  • Listar anexos
  • Exemplo de requisição (listar)
  • Resposta (listar)
  • Erros (listar)
  • Anexar arquivo
  • Exemplo de requisição (anexar)
  • Resposta (anexar)
  • Erros (anexar)
  • Reordenar anexos
  • Exemplo de requisição (reordenar)
  • Resposta (reordenar)
  • Erros (reordenar)
  • Veja também