Crear Sucursal

Agrega una nueva sucursal a una organización existente.

Endpoint

POST /organizations/{orgId}/branches

Path Parameters

Nombre	Tipo	Descripción
orgId	string	UUID de la organización.

Headers

Nombre	Tipo	Requerido	Descripción
Authorization	string	Sí	Token de autenticación Bearer (JWT).
x-idempotency	string	Sí	UUID v7 único para garantizar idempotencia.

Body Parameters

Nombre	Tipo	Requerido	Descripción
name	string	Sí	Nombre identificador de la sucursal.
zipCode	string	Sí	Código postal de la ubicación de la sucursal (5 dígitos).
isMain	boolean	No	Si es la sucursal principal (default: false).

Ejemplos de Código

cURL

curl -X POST https://sandbox-api.lummy.com/organizations/${LUMMY_ORG_ID}/branches \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${ACCESS_TOKEN}" \
  -H "x-idempotency: $(uuidgen)" \
  -d '{
    "name": "Sucursal Norte",
    "zipCode": "64000",
    "isMain": false
  }'

Variables de entorno

Define LUMMY_ORG_ID y ACCESS_TOKEN en tu shell:

export LUMMY_ORG_ID="your-organization-id"
export ACCESS_TOKEN="your-access-token"

El ACCESS_TOKEN se obtiene después de que el usuario se autentica en la plataforma Lummy.

Node.js (TypeScript)

import axios, { AxiosError } from 'axios';
import { v4 as uuidv4 } from 'uuid';

interface CreateBranchPayload {
  name: string;
  zipCode: string;
  isMain?: boolean;
}

interface BranchResponse {
  id: string;
  name: string;
  zipCode: string;
  isActive: boolean;
  createdAt: string;
}

async function crearSucursal(): Promise<BranchResponse> {
  const ORG_ID = process.env.LUMMY_ORG_ID!;
  const API_URL = `https://sandbox-api.lummy.com/organizations/${ORG_ID}/branches`;
  const ACCESS_TOKEN = process.env.ACCESS_TOKEN!;

  const payload: CreateBranchPayload = {
    name: "Sucursal Norte",
    zipCode: "64000",
    isMain: false
  };

  try {
    const response = await axios.post<BranchResponse>(API_URL, payload, {
      headers: {
        'Content-Type': 'application/json',
        'Authorization': `Bearer ${ACCESS_TOKEN}`,
        'x-idempotency': uuidv4(),
      },
    });

    console.log('✅ Sucursal creada exitosamente');
    console.log('ID:', response.data.id);

    return response.data;
  } catch (error) {
    if (axios.isAxiosError(error)) {
      const axiosError = error as AxiosError;
      console.error('❌ Error al crear sucursal:', axiosError.response?.data);
      throw axiosError;
    }
    throw error;
  }
}

// Ejecutar
crearSucursal();

Dependencias

npm install axios uuid
npm install -D @types/uuid

Variables de entorno

Define LUMMY_ORG_ID y ACCESS_TOKEN en tu shell. El ACCESS_TOKEN se obtiene después de que el usuario se autentica en la plataforma Lummy.

Python

import os
import requests
from uuid import uuid4

def crear_sucursal():
    org_id = os.getenv("LUMMY_ORG_ID")
    access_token = os.getenv("ACCESS_TOKEN")
    
    if not org_id or not access_token:
        raise ValueError("Debes definir LUMMY_ORG_ID y ACCESS_TOKEN")

    api_url = f"https://sandbox-api.lummy.com/organizations/{org_id}/branches"

    headers = {
        "Content-Type": "application/json",
        "Authorization": f"Bearer {access_token}",
        "x-idempotency": str(uuid4()),
    }

    payload = {
        "name": "Sucursal Norte",
        "zipCode": "64000",
        "isMain": False
    }

    try:
        response = requests.post(api_url, json=payload, headers=headers, timeout=30)
        response.raise_for_status()

        data = response.json()
        print("✅ Sucursal creada exitosamente")
        print(f"ID: {data['id']}")
        return data

    except requests.exceptions.RequestException as e:
        print(f"❌ Error al crear sucursal: {e}")
        if e.response:
             print(f"Detalle: {e.response.text}")
        raise

if __name__ == "__main__":
    crear_sucursal()

Dependencias

pip install requests

Variables de entorno

Define LUMMY_ORG_ID y ACCESS_TOKEN en tu shell. El ACCESS_TOKEN se obtiene después de que el usuario se autentica en la plataforma Lummy.

PHP (Guzzle)

<?php

require 'vendor/autoload.php';

use GuzzleHttp\Client;
use GuzzleHttp\Exception\RequestException;
use Ramsey\Uuid\Uuid;

function crearSucursal()
{
    $orgId = getenv('LUMMY_ORG_ID');
    $accessToken = getenv('ACCESS_TOKEN');

    if (!$orgId || !$accessToken) {
        throw new Exception('Debes definir LUMMY_ORG_ID y ACCESS_TOKEN');
    }

    $apiUrl = "https://sandbox-api.lummy.com/organizations/{$orgId}/branches";

    $client = new Client([
        'timeout' => 30,
        'headers' => [
            'Content-Type' => 'application/json',
            'Authorization' => 'Bearer ' . $accessToken,
            'x-idempotency' => Uuid::uuid4()->toString(),
        ],
    ]);

    $payload = [
        "name" => "Sucursal Norte",
        "zipCode" => "64000",
        "isMain" => false
    ];

    try {
        $response = $client->post($apiUrl, ['json' => $payload]);
        $data = json_decode($response->getBody(), true);

        echo "✅ Sucursal creada exitosamente\n";
        echo "ID: " . $data['id'] . "\n";
        return $data;

    } catch (RequestException $e) {
        echo "❌ Error al crear sucursal: " . $e->getMessage() . "\n";
        if ($e->getResponse()) {
            echo "Detalle: " . $e->getResponse()->getBody() . "\n";
        }
        throw $e;
    }
}

try {
    crearSucursal();
} catch (Exception $e) {
    echo "Error: " . $e->getMessage() . "\n";
    exit(1);
}

Dependencias

composer require guzzlehttp/guzzle ramsey/uuid

Variables de entorno

Define LUMMY_ORG_ID y ACCESS_TOKEN en tu shell. El ACCESS_TOKEN se obtiene después de que el usuario se autentica en la plataforma Lummy.

Respuestas

201 Created

Sucursal creada exitosamente.

{
  "id": "789e8400-e29b-41d4-a716-446655449999"
}

404 Not Found

La organización especificada no existe.