Pular para o conteúdo principal

Gestão de Imagens de Produtos (SKU)

Endpoints Disponíveis

  • POST /v1/storages/image/upload - Upload de imagens
  • GET /v1/storages/file/{externalReference}/{fileType} - Consulta de imagens
  • DELETE /v1/storages/file/{externalReference} - Exclusão de imagens

Upload de imagens

POST /v1/storages/image/upload

  • Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Exemplo de Autorização

Para gerar o valor de Authorization, você precisa codificar suas credenciais (public_key:secret_key) em base64.

echo -n 'public_key:secret_key' | base64

Parâmetros da requisição

  • externalIdentifier (string): Identificador externo do item (referência externa do SKU).

Corpo da Requisição

O corpo da requisição deve ser enviado como multipart/form-data:

CampoTipoNullableDescrição
filesfileNãoImagem(ns) a ser cadastrada.

Respostas

  • 200: Retorna sucesso da operação.
  • 400: Retorna erro de requisição inválida.
  • 500: Retorna erro interno do servidor.

Exemplo de Resposta para Sucesso (200)

{ "operationId": "402fe685-2060-432b-ac57-223eb2e680f3" }

Consulta de imagens

GET /v1/storages/file/{externalReference}/{fileType}

Header

  • Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Parâmetros da requisição

  • externalReference (string): Referência externa do SKU.
  • fileType (int): Tipo de entidade — enviar 1 para SKUs.

Respostas

  • 200: Retorna lista de URLs das imagens.
  • 400: Retorna erro de requisição inválida.
  • 500: Retorna erro interno do servidor.

Exemplo de Resposta para Sucesso (200)

[
"https://storage.blob.core.windows.net/zonasul/e9a2fca6/SKUs/01729925/capa_seca1.jpeg",
"https://storage.blob.core.windows.net/zonasul/e9a2fca6/SKUs/01729925/imagem_2.png"
]

Exclusão de imagens

DELETE /v1/storages/file/{externalReference}

Header

  • Authorization: Basic Auth contendo a chave pública e secreta disponibilizadas para o cliente.
    • Exemplo: Basic <base64-encoded-credentials>
  • x-contractAccountId: Identificador da conta do contrato do cliente.
    • Exemplo: x-contractAccountId: 9f36a666-acd5-4987-a47f-3de247f65d82

Parâmetros da requisição

  • externalReference (string): Referência externa do SKU.

Corpo da Requisição

O corpo da requisição deve conter os seguintes campos:

CampoTipoNullableDescrição
fileTypeintNãoTipo de entidade (1 para SKUs).
urlsarraySimURLs dos arquivos a serem removidos.
storageIdsarraySimIDs dos arquivos armazenados a serem removidos.

Respostas

  • 200: Retorna sucesso da operação.
  • 400: Retorna erro de requisição inválida.
  • 500: Retorna erro interno do servidor.

Exemplo de Resposta para Sucesso (200)

{ "operationId": "402fe685-2060-432b-ac57-223eb2e680f3" }