Documentación B2B

API B2B: consultar información de pedidos y productos de forma automatizada

Nuestra API REST está a disposición de todo cliente con cuenta de cliente y permite consultar de forma automatizada la información de pedidos y productos e integrarla en sistemas propios.

vpn_key Abrir acceso a la API en la cuenta Página de clientes comerciales

Autenticación

Todas las solicitudes a la API requieren una API-Key válida que se envía en el HTTP-Header. El acceso a la API está vinculado a su cuenta de cliente y está disponible, en principio, para las cuentas de cliente.

info No necesita una solicitud B2B aparte: inicie sesión con su cuenta de cliente, abra la pestaña API y genere allí su API-Key. Al acceso a la API →

Formato del header

HTTP Request Header

X-API-Key: YOUR_API_KEY_HERE
Content-Type: application/json
Accept: application/json

Ejemplo con cURL

cURL

curl -X GET "https://artumos.com/api/v1/orders" \
  -H "X-API-Key: YOUR_API_KEY_HERE" \
  -H "Accept: application/json"

Base URL

Todos los endpoints son relativos a la siguiente Base URL:

Base URL

https://artumos.com/api/v1

Todas las respuestas se devuelven como JSON (Content-Type: application/json).

Rate Limits

Plan	Solicitudes / minuto	Solicitudes / día
Cuenta de cliente	60	5.000
Límite ampliado	bajo solicitud	bajo solicitud

Al superarse se devuelve HTTP 429 Too Many Requests . El header Retry-After contiene el tiempo de espera en segundos.

Códigos de error

HTTP-Code	Significado
`200 OK`	Solicitud correcta
`400 Bad Request`	Parámetros no válidos
`401 Unauthorized`	API-Key ausente o no válida
`403 Forbidden`	Sin permiso para este recurso
`404 Not Found`	Recurso no encontrado
`429 Too Many Requests`	Rate Limit superado
`500 Internal Server Error`	Error del servidor; por favor, contacte con soporte

Formato de la respuesta de error

JSON

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key."
  }
}

Endpoint: Pedidos

GET /api/v1/orders Todos los pedidos de la cuenta

Parameter	Tipo	Descripción
`page`	integer	Página (predeterminado: 1)
`per_page`	integer	Entradas por página (máx. 100)
`status`	string	`paid` \| `pending` \| `all`

Beispiel-Response

{
  "success": true,
  "data": {
    "orders": [
      {
        "id": "ORD-12345",
        "status": "paid",
        "total": 49.99,
        "currency": "EUR",
        "created_at": "2026-01-15T10:30:00Z",
        "items_count": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 20,
      "total": 42
    }
  }
}

GET /api/v1/orders/{order_id} Consultar un pedido individual

Endpoint: Información de productos y pedidos

GET /api/v1/orders/{order_id}/codes Toda la información de productos de un pedido

Beispiel-Response

{
  "success": true,
  "data": {
    "order_id": "ORD-12345",
    "codes": [
      {
        "id": "CODE-789",
        "product_name": "Beispielprodukt vom Marktplatz",
        "product_sku": "ART-PRODUCT-001",
        "product_info": "Hinweise laut Verkäuferangaben",
        "delivery_url": "https://...",
        "delivered_at": "2026-01-15T10:31:00Z",
        "status": "active"
      }
    ]
  }
}

GET /api/v1/codes/{code_id} Consultar una información de producto individual

warning La información de productos y pedidos solo puede utilizarse en el marco del respectivo pedido y de las indicaciones del vendedor. Una difusión abusiva puede infringir las condiciones de uso.

Endpoint: Productos

GET /api/v1/products Consultar el catálogo de productos

Parameter	Tipo	Descripción
`category`	string	Filtrar por slug de categoría
`in_stock`	boolean	Solo productos disponibles
`page`	integer	Página

Beispiel-Response

{
  "success": true,
  "data": {
    "products": [
      {
        "id": 42,
        "sku": "ART-PRODUCT-001",
        "name": "Beispielprodukt vom Marktplatz",
        "price": 49.99,
        "currency": "EUR",
        "in_stock": true,
        "category": "handmade"
      }
    ]
  }
}

Webhooks

Los Webhooks permiten recibir notificaciones en tiempo real cuando se proporcionan pedidos o códigos. Las URL de Webhook pueden registrarse en la cuenta de cliente.

Eventos disponibles

Event	Descripción
`order.paid`	El pedido se ha pagado
`codes.delivered`	Los códigos se han proporcionado
`order.refunded`	El pedido se ha reembolsado

Webhook Payload

POST – Su Webhook-Endpoint

{
  "event": "codes.delivered",
  "timestamp": "2026-01-15T10:31:05Z",
  "data": {
    "order_id": "ORD-12345",
    "codes_count": 2
  },
  "signature": "sha256=..."
}

Verifique la firma con su Webhook-Secret: HMAC-SHA256(payload, webhook_secret)

Preguntas frecuentes

¿Quién puede utilizar la API B2B?

Cualquier cliente con cuenta de cliente puede utilizar el acceso a la API. Inicie sesión en su cuenta de cliente y utilice la API-Key correspondiente para las solicitudes autenticadas.

¿Qué formato tienen las respuestas?

Todas las respuestas se devuelven como JSON. El objeto raíz contiene siempre success: true/false así como data o error.

¿Puedo realizar pedidos a través de la API?

En la primera versión, la API sirve para consultar pedidos e información de pedidos y productos. Los endpoints de escritura de pedidos se habilitarán por separado en cuanto estén disponibles.

¿Existe un entorno de sandbox?

Sí. El sandbox puede activarse en la cuenta de cliente en la pestaña «Acceso a la API» y está vinculado directamente a la respectiva API-Key.