Sliders populate the homepage banner carousel on the storefront. Each slider carries an image (stored on OCI Object Storage), display copy, an optional link, pricing display fields, and a type flag that controls which carousel zone it appears in:Documentation Index
Fetch the complete documentation index at: https://mintlify.com/JuanSCaicedo/Api-Ecommerce/llms.txt
Use this file to discover all available pages before exploring further.
type_slider | Zone | Typical use |
|---|---|---|
1 | Principal / Hero | Full-width banner at the top of the homepage |
2 | Secondary | Smaller promotional strip below the hero |
3 | Product carousel | Product-focused promotional banners |
vista_mantenimiento, which activates maintenance mode when set to state = 1.
store, update, and destroy on sliders are throttled at 10 requests per minute per token.Authentication
All/api/admin/ endpoints require:
Sliders
List Sliders
id descending.
Query parameters
Filter by slider
title (SQL LIKE %value%).Total matching sliders across all pages.
Array of slider objects (plain array, not wrapped in a
data key). The imagen field is a fully-qualified OCI Object Storage URL resolved at read time (or null if no image is set).Create Slider
| Header | Value |
|---|---|
| Authorization | Bearer <admin_token> |
| Content-Type | multipart/form-data |
Slider headline text.
Secondary text line displayed below the title.
Call-to-action button label (e.g.,
"Shop Now", "View Collection").Banner image file (JPEG/PNG). The upload field name must be
image (not imagen). The file is uploaded to OCI Object Storage under juandevops/ecommerce/public/sliders/. The OCI storage path is saved in the imagen column.URL the slider links to when clicked (e.g.,
/sale, https://example.com/promo).1 = active (displayed on storefront), 0 = inactive.Carousel zone.
| Value | Zone |
|---|---|
1 | Principal / Hero |
2 | Secondary |
3 | Product carousel |
Optional layout hint consumed by the frontend (e.g.,
"full", "half").Original (pre-sale) price to display on the banner for visual comparison.
Campaign / discounted price to display on the banner.
Hex color code used for banner background or text overlay (e.g.,
"#FF5733").200 on success.The newly created slider ID.
Get Slider
Slider ID.
Full slider object with all fields. The
imagen field is the resolved OCI public URL (or null if no image has been set).Update Slider
UsesPOST (not PUT/PATCH) to support multipart file uploads.
Slider ID to update.
The upload field name must be
image (not imagen).- Omit — leave the current image unchanged.
- Empty string (
"") — delete the current image from OCI and setimagentonull. - New file — delete the old image from OCI and upload the new file.
Delete Slider
SoftDeletes trait (sets deleted_at).
Path parameters
Slider ID to delete.
HomeView Feature Flags
HomeView records are pre-seeded named toggles stored in the database. They are updated (not created or deleted) via the admin API — thestore and destroy actions are intentionally no-ops.
List HomeView Flags
Filter by flag
name (SQL LIKE %value%).Total number of home-view flags.
Array of flag objects (plain array, not wrapped in a
data key). Each object includes id, name, state, and updated_at formatted as "YYYY-MM-DD hh:mm A".Update a HomeView Flag
HomeView flag ID.
The flag’s identifying name. Must remain unique; sending a name that belongs to a different flag record returns
{"message": 403}.1 = enabled, 0 = disabled.200 on success, 403 on name conflict.Updated flag object with
id, name, state, and updated_at.