API RESTful de Dulcerías Denny

Nota

Este documento utiliza la herramienta xh para ejemplificar las peticiones de los endpoints, aunque no se limita a ello, sea libre de utilizar su herramienta de envío de peticiones HTTP preferida.

[GET] https://dulceriasdenny.com/api/v1
xh get https://dulceriasdenny.com/api/v1

{
    "description": "API Restful de Dulcerías Denny",
    "version": "v1",
    "homepage": "https://dulceriasdenny.com/",
    "license": "Genotipo (R)",
    "documentation": "https://dulceriasdenny.com/docs/"
}



Inicio de sesión

Genera un token de autorización a la API.

[POST] https://dulceriasdenny.com/api/v1/auth/login

Importante

Los tokens de autorización son válidos durante 1 hora. Cuando el token de autorización haya vencido debe generar uno nuevo.

Cuerpo de la petición

Campo Tipo Requerido Rango Descripción
email string requerido <= 256 Correo electrónico de acceso.
password string requerido <= 32 Contraseña de acceso.

Ejemplo

xh post https://dulceriasdenny.com/api/v1/auth/login \
    email="ricardo@genotipo.com" \
    password="12345678"

Respuesta

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZCI6IjMiLCJuYW1lIjoiUmljYXJkbyBHYXJjXHUwMGVkYSBKaW1cdTAwZTluZXoiLCJlbWFpbCI6InJpY2FyZG9AZ2Vub3RpcG8uY29tIiwicm9sZSI6ImFkbWluIiwiZXhwIjoxNjgxNDI4MDY5LCJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjgwODAvIiwic3ViIjoiRHVsY2VyXHUwMGVkYXMgRGVubnkiLCJhdWQiOiJodHRwOi8vbG9jYWxob3N0OjgwODAvIiwiaWF0IjoxNjgxNDI0NDY5LCJuYmYiOjE2ODE0MjQ0Njl9.XcvFmoihxy7WrHqXtNypC9ctJ9-L0IbF6GsDxcEJyI8",
    "token_type": "bearer",
    "expires_at": "2023-04-13 18:21:09"
}



Usuario autenticado

Consulta la información de un usuario autenticado.

[GET] https://dulceriasdenny.com/api/v1/auth/me

Ejemplo

xh get https://dulceriasdenny.com/api/v1/auth/me \
    -A bearer \
    -a YOUR_ACCESS_TOKEN

Respuesta

{
    "id": "1",
    "name": "Ricardo García Jiménez",
    "email": "ricardo@genotipo.com",
    "role": "Administrador",
    "created_at": "2023-04-13 11:39:12",
    "updated_at": "2023-04-13 11:39:12"
}



Búsqueda de productos

Busca y consulta todos los productos registrados.

[GET] https://dulceriasdenny.com/api/v1/products

Parámetros de consulta

Campo Tipo Requerido Por defecto Rango Valores permitidos Descripción
page integer opcional > 0 Número de página.
perPage integer opcional 8 > 0 Número de resultados por página.
filter string opcional name sku, name Filtro de búsqueda.
q string opcional <= 256 Patrón de búsqueda.
sortBy string opcional id id, sku, name, price, quantity, created_at, updated_at Campo de ordenamiento de resultados.
sortOrder string opcional asc asc, desc Modo de ordenamiento de resultados.
active boolean opcional 1, 0 Filtra los resultado por activados o desactivados.
dateFrom string opcional AÑO-MES-DÍA Filtra los resultados desde una fecha de registro.
dateTo string opcional AÑO-MES-DÍA Filtra los resultados hasta una fecha de registro.

Ejemplo

xh get https://dulceriasdenny.com/api/v1/products \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    page==1 \
    perPage==16 \
    filter=="name" \
    q=="gomitas" \
    sortBy=="price" \
    sortOder=="desc" \
    active==1 \
    dateFrom="2023-04-01" \
    dateTo="2023-04-30"

Respuesta

{
    "data": [
        {
            "id": "1",
            "sku": "030001",
            "name": "Panditas clásicos",
            "slug": "panditas-clasicos",
            "description": "Gomitas sabores frutales: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos.",
            "brand": "ricolino",
            "category": "gomitas",
            "price": "20.00",
            "discount_price": "15.00",
            "quantity": "120",
            "weight": "0.275",
            "length": "4",
            "width": "27",
            "height": "31",
            "seasons": [
                "diadelnino",
                "navidad"
            ],
            "families": [
                "030003",
                "030004"
            ],
            "active": "1",
            "wholesale_price": "16.00",
            "wholesale_quantity": "20",
            "created_at": "2023-04-12 17:08:57",
            "updated_at": "2023-04-12 17:08:57",
            "link": "https://dulceriasdenny.com/productos/panditas-clasicos"
        },
        {
            "id": "2",
            "sku": "030002",
            "slug": "panditas-enchilados",
            "name": "Panditas enchilados",
            "description": "Gomitas sabores frutales: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos.",
            "brand": "ricolino",
            "category": "gomitas",
            "price": "20.00",
            "discount_price": null,
            "quantity": "120",
            "weight": "0.275",
            "length": "4",
            "width": "27",
            "height": "31",
            "seasons": [],
            "families": [],
            "active": "0",
            "wholesale_price": null,
            "wholesale_quantity": null,
            "created_at": "2023-04-12 17:09:20",
            "updated_at": "2023-04-12 17:09:20",
            "link": "https://dulceriasdenny.com/productos/panditas-enchilados"
        },
        ...
    ],
    "pagination": {
        ...
    }
}



Obtener producto

Consulta la información de un producto registrado.

[GET] https://dulceriasdenny.com/api/v1/products/(:sku)

Ejemplo

xh get https://dulceriasdenny.com/api/v1/products/030001 \
    -A bearer \
    -a YOUR_ACCESS_TOKEN

Respuesta

{
    "id": "1",
    "sku": "030001",
    "slug": "panditas-clasicos",
    "name": "Panditas clásicos",
    "description": "Gomitas sabores frutales: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos.",
    "brand": "ricolino",
    "category": "gomitas",
    "price": "20.00",
    "discount_price": "15.00",
    "quantity": "120",
    "weight": "0.275",
    "length": "4",
    "width": "27",
    "height": "31",
    "seasons": [
        "diadelnino",
        "navidad"
    ],
    "families": [
        "030002",
        "030003"
    ],
    "active": "1",
    "wholesale_price": "16.00",
    "wholesale_quantity": "20",
    "created_at": "2023-04-12 12:32:15",
    "updated_at": "2023-04-12 12:32:15",
    "link": "https://dulceriasdenny.com/productos/panditas-clasicos"
}



Registro de productos

Registra la información de un producto.

[POST] https://dulceriasdenny.com/api/v1/products

Cuerpo de la petición

Campo Tipo Requerido Por defecto Rango Descripción
sku string requerido <= 64 Código de referencia del producto.
name string requerido <= 256 Nombre del producto.
description string requerido <= 512 Descripción del producto.
brand string requerido <= 64 Tag de la marca del producto.
category string requerido <= 64 Tag de la categoría del producto.
price float requerido > 0 Precio unitario del producto.
discount_price float opcional null >= 0 Precio con descuento unitario del producto.
quantity integer requerido >= 0 Cantidad en stock del producto.
weight float requerido > 0 Peso del producto en kilogramos.
length float requerido > 0 Largo del producto en centímetros.
width float requerido > 0 Ancho del producto en centímetros.
height float requerido > 0 Alto del producto en centímetros.
seasons array opcional Array de tags de las temporadas del producto.
active boolean opcional 1 1, 0 Activa o desactiva el producto.
wholesale_price float opcional null >= 0 Precio del producto por mayoreo.
wholesale_quantity integer opcional null >= 0 Cantidad de productos requerida para aplicar el precio de mayoreo.
families array opcional Array de strings de skus existentes de familia de productos.

Nota

Asigne un tag válido en la propiedad de temporada consultando los tags disponibles desde el endpoint de la entidad.

Ejemplo

xh post https://dulceriasdenny.com/api/v1/products \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    sku="030001" \
    name="Panditas clásicos" \
    description="Gomitas sabores frutales: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos." \
    brand="ricolino" \
    category="gomitas" \
    price=20 \
    discount_price=15.00 \
    quantity=120 \
    weight=0.275 \
    length=4 \
    width=27 \
    height=31 \
    seasons[]="diadelnino" \
    seasons[]="navidad" \
    active=1 \
    families[]="030002" \
    families[]="030003" \
    wholesale_price=16 \
    wholesale_quantity=20

Respuesta

{
    "id": "1",
    "sku": "030001",
    "slug": "panditas-clasicos",
    "name": "Panditas clásicos",
    "description": "Gomitas sabores frutales: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos.",
    "brand": "ricolino",
    "category": "gomitas",
    "price": "20.00",
    "discount_price": "15.00",
    "quantity": "120",
    "weight": "0.275",
    "length": "4",
    "width": "27",
    "height": "31",
    "seasons": [
        "diadelnino",
        "navidad"
    ],
    "families": [
        "030002",
        "030003"
    ],
    "active": "1",
    "wholesale_price": "16.00",
    "wholesale_quantity": "20",
    "created_at": "2023-04-12 12:32:15",
    "updated_at": "2023-04-12 12:32:15",
    "link": "https://dulceriasdenny.com/productos/panditas-clasicos"
}



Modificar productos

Modifica o actualiza la información de un producto registrado.

[PUT] https://dulceriasdenny.com/api/v1/products/(:sku)

Cuerpo de la petición

Campo Tipo RequeridoRango Descripción
sku string opcional <= 64 Código de referencia del producto.
name string opcional <= 256 Nombre del producto.
description string opcional <= 512 Descripción del producto.
brand string opcional <= 64 Tag de la marca del producto.
category string opcional <= 64 Tag de la categoría del producto.
price float opcional > 0 Precio unitario del producto.
discount_price float opcional >= 0 Precio con descuento unitario del producto.
quantity integer opcional >= 0 Cantidad en stock del producto.
weight float opcional > 0 Peso del producto en kilogramos.
length float opcional > 0 Largo del producto en centímetros.
width float opcional > 0 Ancho del producto en centímetros.
height float opcional > 0 Alto del producto en centímetros.
seasons array opcional Array de tags de las temporadas del producto.
active boolean opcional 1, 0 Activa o desactiva el producto.
wholesale_price float opcional >= 0 Precio del producto por mayoreo.
wholesale_quantity integer opcional >= 0 Cantidad de productos requerida para aplicar el precio de mayoreo.
families array opcional Array de strings de skus existentes de familia de productos.

Ejemplo

xh put https://dulceriasdenny.com/api/v1/products/030001 \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    sku="030002" \
    name="Panditas enchilados" \
    description="Gomitas sabores frutales enchilados: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos." \
    brand="Ricolino" \
    category="gomitas" \
    price=18 \
    discount_price=0 \
    quantity=0 \
    weight="0.280" \
    length="4" \
    width="28" \
    height="32" \
    seasons:=[] \
    families:=[] \
    active=0 \
    wholesale_price=0 \
    wholesale_quantity=0

Respuesta

{
    "id": "1",
    "sku": "030002",
    "slug": "panditas-enchilados",
    "name": "Panditas enchilados",
    "description": "Gomitas sabores frutales enchilados: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos.",
    "brand": "ricolino",
    "category": "gomitas",
    "price": "18.00",
    "discount_price": null,
    "quantity": "0",
    "weight": "0.280",
    "length": "4",
    "width": "28",
    "height": "32",
    "seasons": [],
    "families": [],
    "active": "0",
    "wholesale_price": null,
    "wholesale_quantity": null,
    "created_at": "2023-04-13 14:31:02",
    "updated_at": "2023-04-13 14:31:12",
    "link": "https://dulceriasdenny.com/productos/panditas-clasicos"
}



Eliminar productos

Elimina el registro de un producto sin ventas.

[DELETE] https://dulceriasdenny.com/api/v1/products/(:sku)

Ejemplo

xh delete https://dulceriasdenny.com/api/v1/products/030001 \
    -A bearer \
    -a YOUR_ACCESS_TOKEN

Respuesta

{
    "id": "1",
    "sku": "030001",
    "slug": "panditas-clasicos",
    "name": "Panditas clásicos",
    "description": "Gomitas sabores frutales: naranja, cereza, limón, piña. Paquete con 20 piezas de 15 gramos cada uno. Peso del paquete: 330 gramos.",
    "brand": "ricolino",
    "category": "gomitas",
    "price": "20.00",
    "discount_price": "15.00",
    "quantity": "120",
    "weight": "0.275",
    "length": "4",
    "width": "27",
    "height": "31",
    "seasons": [
        "diadelnino",
        "navidad"
    ],
    "families": [
        "030002",
        "030003"
    ],
    "active": "1",
    "wholesale_price": "16.00",
    "wholesale_quantity": "20",
    "created_at": "2023-04-12 12:32:15",
    "updated_at": "2023-04-12 12:32:15",
    "link": "https://dulceriasdenny.com/productos/panditas-clasicos"
}



Búsqueda de marcas

Busca y consulta todas las marcas registradas.

[GET] https://dulceriasdenny.com/api/v1/brands

Parámetros de consulta

Campo Tipo Requerido Por defecto Rango Valores permitidos Descripción
page integer opcional > 0 Número de página.
perPage integer opcional 8 > 0 Número de resultados por página.
filter string opcional tag name, tag Filtro de búsqueda.
q string opcional <= 128 Patrón de búsqueda.
sortBy string opcional id id, tag, name, created_at, updated_at Campo de ordenamiento de resultados.
sortOrder string opcional asc asc, desc Modo de ordenamiento de resultados.

Ejemplo

xh get https://dulceriasdenny.com/api/v1/brands \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    page==1 \
    perPage==16 \
    filter=="name" \
    q=="ricolino" \
    sortBy=="created_at" \
    sortOder=="desc"

Respuesta

{
    "data": [
        {
            "id": "1",
            "tag": "ricolino",
            "name": "Ricolino",
            "created_at": "2023-04-13 12:31:06",
            "updated_at": "2023-04-13 12:31:06"
        },
        {
            "id": "2",
            "tag": "vero",
            "name": null,
            "created_at": "2023-04-13 12:31:06",
            "updated_at": "2023-04-13 12:31:06"
        },
        ...
    ],
    "pagination": {
        ...
    }
}



Búsqueda de categorías

Busca y consulta todas las categorías registradas.

[GET] https://dulceriasdenny.com/api/v1/categories

Parámetros de consulta

Campo Tipo Requerido Por defecto Rango Valores permitidos Descripción
page integer opcional > 0 Número de página.
perPage integer opcional 8 > 0 Número de resultados por página.
filter string opcional tag name, tag Filtro de búsqueda.
q string opcional <= 128 Patrón de búsqueda.
sortBy string opcional id id, tag, name, created_at, updated_at Campo de ordenamiento de resultados.
sortOrder string opcional asc asc, desc Modo de ordenamiento de resultados.

Ejemplo

xh get https://dulceriasdenny.com/api/v1/categories \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    page==1 \
    perPage==16 \
    filter=="name" \
    q=="chocolates" \
    sortBy=="created_at" \
    sortOder=="desc"

Respuesta

{
    "data": [
        {
            "id": "1",
            "tag": "chocolates",
            "name": "Chocolates",
            "created_at": "2023-04-13 11:39:12",
            "updated_at": "2023-04-13 11:39:12"
        },
        {
            "id": "2",
            "tag": "paletas",
            "name": "Paletas",
            "created_at": "2023-04-13 11:39:12",
            "updated_at": "2023-04-13 11:39:12"
        },
        ...
    ],
    "pagination": {
        ...
    }
}



Búsqueda de temporadas

Busca y consulta todas las temporadas registradas.

[GET] https://dulceriasdenny.com/api/v1/seasons

Parámetros de consulta

Campo Tipo Requerido Por defecto Rango Valores permitidos Descripción
page integer opcional > 0 Número de página.
perPage integer opcional 8 > 0 Número de resultados por página.
filter string opcional tag name, tag Filtro de búsqueda.
q string opcional <= 128 Patrón de búsqueda.
sortBy string opcional id id, tag, name, created_at, updated_at Campo de ordenamiento de resultados.
sortOrder string opcional asc asc, desc Modo de ordenamiento de resultados.

Ejemplo

xh get https://dulceriasdenny.com/api/v1/seasons \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    page==1 \
    perPage==16 \
    filter=="name" \
    q=="día del niño" \
    sortBy=="created_at" \
    sortOder=="desc"

Respuesta

{
    "data": [
        {
            "id": "1",
            "tag": "diadelnino",
            "name": "Día del Niño",
            "active": "0",
            "started_at": null,
            "finished_at": null,
            "created_at": "2023-04-13 11:39:12",
            "updated_at": "2023-04-13 11:39:12"
        },
        {
            "id": "2",
            "tag": "diadelasmadres",
            "name": "Día de las madres",
            "active": "0",
            "started_at": null,
            "finished_at": null,
            "created_at": "2023-04-13 11:39:12",
            "updated_at": "2023-04-13 11:39:12"
        },
        ...
    ],
    "pagination": {
        ...
    }
}



Consulta todas las ventas

[GET] https://dulceriasdenny.com/api/v1/sales

Parámetros de consulta

Campo Tipo Requerido Por defecto Rango Valores permitidos Descripción
page integer opcional > 0 Número de página.
perPage integer opcional 8 > 0 Número de resultados por página.
sortBy string opcional id id, created_at, updated_at Campo de ordenamiento de resultados.
sortOrder string opcional asc asc, desc Modo de ordenamiento de resultados.
status string opcional <= 32 completed, pending, canceled Filtra los resultados por estatus de venta.
dateFrom string opcional AÑO-MES-DÍA Filtra los resultados desde una fecha de registro.
dateTo string opcional AÑO-MES-DÍA Filtra los resultados hasta una fecha de registro.

Datos de facturación

Campo Tipo Descripción
bill.reason string Razón social.
bill.rfc string Registro Federal de Contribuyentes.
bill.type string Tipo de persona (Física o Moral).
bill.regime object Datos del régimen fiscal.
bill.regime.code integer Código de régimen fiscal del SAT.
bill.regime.name string Nombre del régimen fiscal.
bill.cfdi object Datos de uso de CFDI
bill.cfdi.code string Código de uso de CFDI del SAT.
bill.cfdi.name string Nombre de uso de CFDI.
bill.suburb string Colonia (domicilio fiscal).
bill.zip string Código postal (domicilio fiscal).
bill.state string Estado (domicilio fiscal).
bill.municipality string Municipio (domicilio fiscal).
bill.phone string Teléfono (domicilio fiscal).
bill.email string Correo electrónico (domicilio fiscal).

Nota

Para ventas que no requieran facturación el valor por defecto del campo bill es null.

Ejemplo

xh get https://dulceriasdenny.com/api/v1/sales \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    page==1 \
    perPage==16 \
    sortBy=="created_at" \
    sortOder=="desc" \
    status=="pending" \
    dateFrom="2023-04-01" \
    dateTo="2023-04-30"

Respuesta

{
    "data": [
        {
            "id": "1",
            "status": "Completada",
            "customer": {
                "name": "Ricardo García Jiménez",
                "email": "ricardo@genotipo.com",
                "municipality": "Celaya",
                "number": "100",
                "phone": "1234567890",
                "state": "Guanajuato",
                "street": "Porfirio Diaz",
                "suburb": "",
                "zip": "38930"
            },
            "bill": {
                "reason": "Ricardo García Jiménez",
                "rfc": "ABCDEFGHIJKLM",
                "type": "Física",
                "regime": {
                    "code": "605",
                    "name": "Sueldos y Salarios e Ingresos Asimilados a Salarios"
                },
                "cfdi": {
                    "code": "CN01",
                    "name": "Nómina"
                },
                "suburb": "Colonia Guanajuato",
                "zip": "38930",
                "state": "Guanajuato",
                "municipality": "Celaya",
                "phone": "1234567890",
                "email": "ricardo@genotipo.com"
            },
            "items": [
                {
                    "product": {
                        "id": "3",
                        "name": "Doritos",
                        "sku": "10002",
                        "regular_price": "50.00",
                        "discount_price": null,
                        "isWholesale": 0,
                        "wholesale_price": "35.00",
                        "wholesale_quantity": 20
                    },
                    "quantity": 16,
                    "price": 50
                },
                ...
            ],
            "shipment": "250",
            "observations": "Solicitó facturación",
            "created_at": "2023-06-16 18:20:33",
            "updated_at": "2023-06-17 13:24:44"
        },
        {
            "id": "2",
            "status": "Pendiente",
            "customer": {
                "name": "Paulina Montes García",
                "email": "pau.mon8@gmail.com",
                "municipality": "Celaya",
                "number": "205",
                "phone": "4561160101",
                "state": "Guanajuato",
                "street": "Mariano arista",
                "suburb": "",
                "zip": "38065"
            },
            bill: null,
            "items": [
                {
                    "product": {
                        "id": "2",
                        "name": "Sabritas",
                        "sku": "10001",
                        "regular_price": "50.00",
                        "discount_price": null,
                        "isWholesale": null,
                        "wholesale_price": null,
                        "wholesale_quantity": null
                    },
                    "quantity": 1,
                    "price": 50
                },
                ...
            ],
            "shipment": "150",
            "observations": null,
            "created_at": "2023-06-16 17:05:18",
            "updated_at": "2023-06-16 17:05:18"
        },
        ...
    ],
    "pagination": {
        ...
    }
}



Obtener venta

Consulta la información de una venta registrada.

[GET] https://dulceriasdenny.com/api/v1/sales/(:id)

Ejemplo

xh get https://dulceriasdenny.com/api/v1/sales/1 \
    -A bearer \
    -a YOUR_ACCESS_TOKEN

Respuesta

{
    "id": "1",
    "status": "Completada",
    "customer": {
        "name": "Ricardo García Jiménez",
        "email": "ricardo@genotipo.com",
        "municipality": "Celaya",
        "number": "100",
        "phone": "1234567890",
        "state": "Guanajuato",
        "street": "Porfirio Diaz",
        "suburb": "",
        "zip": "38930"
    },
    "bill": {
        "reason": "Ricardo García Jiménez",
        "rfc": "ABCDEFGHIJKLM",
        "type": "Física",
        "regime": {
            "code": "605",
            "name": "Sueldos y Salarios e Ingresos Asimilados a Salarios"
        },
        "cfdi": {
            "code": "CN01",
            "name": "Nómina"
        },
        "suburb": "Colonia Guanajuato",
        "zip": "38930",
        "state": "Guanajuato",
        "municipality": "Celaya",
        "phone": "1234567890",
        "email": "ricardo@genotipo.com"
    },
    "items": [
        {
            "product": {
                "id": "23",
                "name": "Panditas clasicos",
                "sku": "100001",
                "regular_price": "20.00",
                "discount_price": "15.00",
                "isWholesale": 0,
                "wholesale_price": "35.00",
                "wholesale_quantity": 20
            },
            "quantity": 1,
            "price": 15
        },
        {
            "product": {
                "id": "24",
                "name": "Panditas enchilados",
                "sku": "100002",
                "regular_price": "20.00",
                "discount_price": "",
                "isWholesale": 0,
                "wholesale_price": "15.00",
                "wholesale_quantity": 20
            },
            "quantity": 2,
            "price": 20
        },
        ...
    ],
    "shipment": "150",
    "observations": "Solicitó facturación",
    "created_at": "2023-06-16 18:20:33",
    "updated_at": "2023-06-17 13:24:44"
}



Modificar ventas

Modifica o actualiza la información de una venta registrada.

[PUT] https://dulceriasdenny.com/api/v1/sales/(:id)

Cuerpo de la petición

Campo Tipo RequeridoRango Valores permitidos Descripción
status string opcional <= 32 completed, pending, canceled Tag del estatus de la venta.
observations string opcional <= 4096 Observaciones o notas de la venta.

Ejemplo

xh put https://dulceriasdenny.com/api/v1/sales/1 \
    -A bearer \
    -a YOUR_ACCESS_TOKEN \
    status="completed" \
    observations="Solicitó facturación"

Respuesta

{
    "id": "1",
    "status": "Completada",
    "customer": {
        "name": "Ricardo García Jiménez",
        "email": "ricardo@genotipo.com",
        "municipality": "Celaya",
        "number": "100",
        "phone": "1234567890",
        "state": "Guanajuato",
        "street": "Porfirio Diaz",
        "suburb": "",
        "zip": "38930"
    },
    "shipment": "150",
    "observations": "Solicitó facturación",
    "created_at": "2023-06-16 18:20:33",
    "updated_at": "2023-06-17 13:45:06"
}