API de Proveedor Verdmarket
API REST para gestionar programáticamente sus productos, stock, precios y pedidos.
URL base
Endpoints disponibles
| Método | Endpoint | Descripción |
|---|---|---|
| GET | /products | Listar productos |
| GET | /products/{id} | Detalle de producto |
| POST | /products | Crear producto |
| POST | /products/{id} | Actualizar producto |
| POST | /products/{id}/delete | Eliminar producto |
| GET | /products/{id}/images | Listar imágenes del producto |
| POST | /products/{id}/images | Agregar imágenes por URL |
| POST | /products/{id}/images/{imageId}/delete | Eliminar imagen |
| POST | /products/{id}/images/{imageId}/primary | Establecer imagen principal |
| POST | /stock | Actualización masiva de stock |
| POST | /prices | Actualización masiva de precios |
| GET | /orders | Listar pedidos |
| GET | /orders/{id} | Detalle de pedido |
| POST | /orders/{id}/status | Actualizar estado de pedido |
| GET | /categories | Listar categorías |
Autenticación
Todas las solicitudes API requieren un token Bearer en el encabezado Authorization.
Genere su clave API desde Panel de proveedor → Perfil de tienda → Claves API.
Límites de solicitudes
Por defecto: 1.000 solicitudes por hora por clave API.
La información de límites se devuelve en los encabezados de respuesta:
| Encabezado | Descripción |
|---|---|
| X-RateLimit-Limit | Máximo de solicitudes por hora |
| X-RateLimit-Remaining | Solicitudes restantes en la ventana actual |
| X-RateLimit-Reset | Marca de tiempo Unix del reinicio de la ventana |
| Retry-After | Segundos hasta reintentar (solo en 429) |
Formato de respuesta
Todas las respuestas son JSON. Respuestas exitosas:
{
"success": true,
"data": { ... }
}Respuestas de error:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Name is required."
}
}Productos
/products
Lista sus productos con paginación y filtrado.
Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
| page | int | Número de página (por defecto: 1) |
| per_page | int | Elementos por página (máx.: 100, por defecto: 20) |
| status | string | Filtro: active, inactive, pending |
| search | string | Buscar por nombre o SKU |
Respuesta de ejemplo
{
"success": true,
"data": {
"products": [
{
"id": 42,
"name": "Red Roses Premium",
"sku": "ROSE-RED-001",
"type": "flower",
"base_price": 2.50,
"unit": "stem",
"stock_qty": 500,
"stock_status": "in_stock",
"is_active": true,
"is_approved": true,
"category": { "id": 3, "name": "Roses" },
"primary_image": "/uploads/products/rose-red.jpg"
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 94,
"per_page": 20
}
}
}/products/{id}
Obtener un producto con imágenes y variantes.
/products
Crear un producto nuevo. Los productos nuevos requieren aprobación del administrador antes de aparecer en el catálogo.
Cuerpo de la solicitud (JSON)
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| name | string | * | Nombre del producto |
| category_id | int | * | ID de categoría |
| base_price | float | * | Precio en EUR |
| unit | string | * | tallo, ramo, caja, paquete, pieza, kilogramo, metro, rollo |
| type | string | flower (por defecto) o supply | |
| description | string | Descripción del producto | |
| sku | string | SKU único (verificado contra duplicados) | |
| stock_qty | int | Cantidad en stock (por defecto: 0) | |
| min_order_qty | int | Cantidad mínima de pedido (por defecto: 1) | |
| color | string | Color del producto | |
| stem_length | int | Longitud del tallo en cm | |
| country_of_origin | string | País de origen | |
| vat_rate | float | Tasa de IVA en % (por defecto: 21) | |
| image_url | string | URL(s) de imagen. Soporta jpg, png, webp. Múltiples URLs separadas por punto y coma (;). Máximo 10 imágenes por producto. |
/products/{id}
Actualizar un producto existente. Envíe solo los campos que desea cambiar (actualización parcial).
/products/{id}/delete
Eliminación suave de un producto. No requiere cuerpo de solicitud.
Imágenes del producto
/products/{id}/images
Obtener todas las imágenes de un producto. Devuelve URLs e indicador de imagen principal.
Respuesta de ejemplo
{
"success": true,
"data": {
"images": [
{
"id": 1,
"url": "/uploads/products/abc123.jpg",
"thumbnail_url": "/uploads/products/thumb_abc123.jpg",
"is_primary": true
},
{
"id": 2,
"url": "/uploads/products/def456.jpg",
"thumbnail_url": "/uploads/products/thumb_def456.jpg",
"is_primary": false
}
]
}
}/products/{id}/images
Agregar imágenes proporcionando URLs. El servidor descarga, valida (jpg/png/webp, máx. 5 MB) y crea miniaturas automáticamente. Use punto y coma para separar múltiples URLs.
Cuerpo de la solicitud (JSON)
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| image_url | string | * | URL(s) de imagen. Soporta jpg, png, webp. Múltiples URLs separadas por punto y coma (;). Máximo 10 imágenes por producto. |
Cuerpo de la solicitud
{
"image_url": "https://example.com/images/rose.jpg;https://example.com/images/rose-2.jpg"
}/products/{id}/images/{imageId}/delete
Eliminar una imagen del producto. El archivo se elimina del servidor. Si la imagen eliminada era la principal, la siguiente imagen se convierte en principal automáticamente.
/products/{id}/images/{imageId}/primary
Establecer una imagen como principal. La imagen principal se muestra en los listados del catálogo y resultados de búsqueda.
Actualización masiva de stock
/stock
Actualizar cantidades de stock para múltiples productos a la vez. Identifique productos por product_id o sku. Máx. 500 elementos por solicitud.
Cuerpo de la solicitud
{
"items": [
{ "product_id": 42, "stock_qty": 500 },
{ "sku": "ROSE-RED-001", "stock_qty": 250 },
{ "sku": "LILY-WHT-003", "stock_qty": 0 }
]
}Respuesta
{
"success": true,
"data": {
"updated": 2,
"failed": 1,
"errors": [
{ "index": 2, "sku": "LILY-WHT-003", "error": "Product not found" }
]
}
}Actualización masiva de precios
/prices
Actualizar precios para múltiples productos. Mismo formato que actualización de stock pero con campo base_price. Máx. 500 elementos.
Cuerpo de la solicitud
{
"items": [
{ "product_id": 42, "base_price": 2.75 },
{ "sku": "ROSE-RED-001", "base_price": 3.10 }
]
}Pedidos
/orders
Lista sus grupos de pedidos (porciones de pedidos específicas del proveedor).
Parámetros de consulta
| Parámetro | Tipo | Descripción |
|---|---|---|
| page | int | Número de página |
| per_page | int | Elementos por página (máx. 100) |
| status | string | pending, confirmed, processing, shipped, delivered, completed, cancelled |
/orders/{id}
Detalle completo del pedido incluyendo artículos, información del cliente e historial de estados.
/orders/{id}/status
Actualizar estado del pedido. Solo se permiten transiciones válidas:
| Desde | Transiciones permitidas |
|---|---|
| pending | confirmed, cancelled |
| confirmed | processing, cancelled |
| processing | shipped, cancelled |
| shipped | delivered |
Cuerpo de la solicitud
{
"status": "confirmed",
"comment": "Order confirmed, preparing for shipment"
}Categorías
/categories
Lista todas las categorías activas. Devuelve una lista plana con referencias a padres.
Respuesta de ejemplo
{
"success": true,
"data": {
"categories": [
{ "id": 1, "name": "Flowers", "slug": "flowers", "parent_id": null, "type": "flower" },
{ "id": 3, "name": "Roses", "slug": "roses", "parent_id": 1, "type": "flower" }
]
}
}Códigos de error
| HTTP | Código | Descripción |
|---|---|---|
| 401 | UNAUTHORIZED | Clave API faltante o no válida |
| 403 | FORBIDDEN | Clave revocada o proveedor no verificado |
| 404 | NOT_FOUND | Recurso no encontrado |
| 422 | VALIDATION_ERROR | Datos de entrada no válidos |
| 429 | RATE_LIMITED | Límite de solicitudes excedido |
| 500 | SERVER_ERROR | Error interno del servidor |
Ejemplos de código
Listar productos
curl -X GET "https://verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/products?page=1&per_page=10" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Crear producto
curl -X POST "https://verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/products" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Red Roses Premium",
"category_id": 3,
"base_price": 2.50,
"unit": "stem",
"stock_qty": 500,
"sku": "ROSE-RED-001",
"color": "Red",
"stem_length": 60,
"country_of_origin": "Netherlands",
"image_url": "https://example.com/images/rose-red.jpg"
}'Agregar imágenes del producto
curl -X POST "https://verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/products/42/images" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image_url": "https://example.com/img/photo1.jpg;https://example.com/img/photo2.jpg"
}'Actualización masiva de stock
curl -X POST "https://verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/stock" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{"sku": "ROSE-RED-001", "stock_qty": 500},
{"sku": "LILY-WHT-003", "stock_qty": 200}
]
}'Ejemplo PHP
<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier';
// List products
$ch = curl_init("$baseUrl/products?page=1&per_page=10");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer $apiKey",
"Accept: application/json",
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
// Bulk stock update
$ch = curl_init("$baseUrl/stock");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode([
'items' => [
['sku' => 'ROSE-RED-001', 'stock_qty' => 500],
['sku' => 'LILY-WHT-003', 'stock_qty' => 200],
],
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer $apiKey",
"Content-Type: application/json",
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);Ejemplo Python
import requests
API_KEY = "YOUR_API_KEY"
BASE_URL = "https://verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier"
headers = {"Authorization": f"Bearer {API_KEY}"}
# List products
resp = requests.get(f"{BASE_URL}/products", headers=headers,
params={"page": 1, "per_page": 10})
products = resp.json()
# Bulk stock update
resp = requests.post(f"{BASE_URL}/stock", headers=headers,
json={"items": [
{"sku": "ROSE-RED-001", "stock_qty": 500},
{"sku": "LILY-WHT-003", "stock_qty": 200},
]})
result = resp.json()
# Update order status
resp = requests.post(f"{BASE_URL}/orders/15/status", headers=headers,
json={"status": "confirmed",
"comment": "Ready for shipment"})
print(resp.json())