Gestión de Pedidos

Aprende a obtener, actualizar y procesar pedidos a través de la API.

Descripción General

Los pedidos representan compras realizadas en una tienda Whatalo. La API de Orders te permite obtener detalles de pedidos, actualizar estados e integrar con sistemas de fulfillment.

Los pedidos son creados por los clientes a través del storefront. La API te permite leer y actualizar pedidos, no crearlos directamente.

Listar Pedidos

curl -X GET https://api.whatalo.com/v1/orders \
  -H "X-API-Key: wk_live_your_key_here"

Scope requerido: read:orders

Obtener un Pedido

curl -X GET https://api.whatalo.com/v1/orders/ord_abc123 \
  -H "X-API-Key: wk_live_your_key_here"

Obtener Artículos del Pedido

Obtén los line items de un pedido específico:

curl -X GET https://api.whatalo.com/v1/orders/ord_abc123/items \
  -H "X-API-Key: wk_live_your_key_here"

Actualizar Estado del Pedido

Puedes actualizar order_status, payment_status e internal_notes:

curl -X PATCH https://api.whatalo.com/v1/orders/ord_abc123 \
  -H "X-API-Key: wk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "order_status": "in_progress",
    "internal_notes": "Handed to courier"
  }'

Scope requerido: write:orders

Ciclo de Vida del Pedido

Los pedidos en Whatalo siguen este ciclo de vida:

pending → confirmed → in_progress → completed
                                   → returned
         → cancelled

Valores de order_status: pending | confirmed | in_progress | completed | cancelled | returned

Valores de payment_status: pending | paid | refunded | failed

Patrones Comunes

Integración de Fulfillment

Marca pedidos como en progreso cuando tu sistema de fulfillment los recoge:

async function markInProgress(orderId) {
  const response = await fetch(
    `https://api.whatalo.com/v1/orders/${orderId}`,
    {
      method: 'PATCH',
      headers: {
        'X-API-Key': API_KEY,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        order_status: 'in_progress',
        internal_notes: 'Picked up by fulfillment system'
      })
    }
  );

  if (!response.ok) {
    throw new Error(`Failed to update order: ${response.status}`);
  }

  return response.json();
}

Conteo de Pedidos para Dashboard

curl -X GET "https://api.whatalo.com/v1/orders/count?status=pending" \
  -H "X-API-Key: wk_live_your_key_here"

On this page