API : Productos Brochures

https://www.obuma.cl/ayuda/articulo/877/api--productos-brochures


API Endpoint: Productos Brochures

 

Permite consultar los brochures asociados a los productos y agregar un brochure externo mediante una URL. Por el momento, la creación solo permite elementos de tipo link.

Listar todos los brochures

  • URL: /productosBrochures.list.json
  • Método: GET
  • Descripción: Obtiene todos los brochures asociados a productos dentro de la empresa autenticada.
  • Parámetros:
    • rel_producto_id: opcional. Permite filtrar los brochures de un producto específico.

 

Obtener brochure por ID

  • URL: /productosBrochures.findById.json/{RecursoId}
  • Método: GET
  • Descripción: Devuelve un brochure específico basado en el ID proporcionado.
  • Parámetros:
    • RecursoId: ID del brochure incluido en la URL.

 

Listar brochures por producto

  • URL: /productosBrochures.findByProductoId.json/{RecursoId}
  • Método: GET
  • Descripción: Obtiene todos los brochures asociados a un producto específico.
  • Parámetros:
    • RecursoId: ID del producto incluido en la URL.

 

Listar brochures por SKU del producto

  • URL: /productosBrochures.findByProductoSku.json/{RecursoId}
  • Método: GET
  • Descripción: Obtiene todos los brochures asociados al producto cuyo SKU coincide con el valor proporcionado.
  • Parámetros:
    • RecursoId: código comercial o SKU del producto incluido en la URL.

 

Agregar brochure tipo link

  • URL: /productosBrochures.create.json
  • Método: POST
  • Descripción: Agrega un link externo como brochure de un producto. El producto debe pertenecer a la empresa autenticada.
  • Cuerpo JSON:
    {
      "rel_producto_id": 123,
      "producto_brochure_url": "https://ejemplo.com/catalogo/producto-123",
      "producto_brochure_nombre": "Catálogo del producto"
    }
  • Campos obligatorios:
    • rel_producto_id: ID del producto al que se asociará el link.
    • producto_brochure_url: URL externa del brochure o catálogo.
  • Campos disponibles:
    • producto_brochure_nombre: nombre visible del brochure. Si no se envía, se utiliza la URL.

 

Valores asignados automáticamente

  • producto_brochure_es_link = 1
  • pbf_type = link
  • pbf_size = 0
  • s3_link: vacío
  • pbf_fecha_ingreso y pbf_usuario_ingreso: registrados por la API.

Importante: por el momento este endpoint no permite cargar archivos ni documentos binarios; solo se pueden agregar brochures mediante una URL.