Algebraix logo
Powered by Redocly

Artículos de venta

Obtener Artículos en venta

Obtener información de los articulos en venta

Request
header Parameters
algebraix-api-token
required
string = 32 characters

ALGEBRAIX API KEY

Example: 52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
Default: false

La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema

NOTA: La instancia se crea desde web.

Responses
200

No error

400

Bad parameters

401

Authorization Required

get/store/items
Request samples 
Response samples 
application/json
[
  • {
    }
]
Agregar artículo en venta
Agregar un nuevo artículo en venta


Request 
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
title
required
string  [ 1 .. 120 ] characters 
Título del artículo en venta


 
description
string
Descripción del artículo en venta


 
name_in_invoices
string  <= 120 characters 
Nombre del artículo en venta dentro de facturas


 
barcode
string  <= 30 characters 
Código de barras del artículo en venta


 
price
required
number (number) ^\d+(\.\d{1,2})?$
Precio del artículo en venta


 
is_payment_entry
boolean
Indica si el artículo es una entrada de pago


 
is_online_store
boolean
Indica si el artículo está disponible en la tienda en línea


 
object
Información de la ficha técnica


 
tax
string
 Default:  "EXEMPT"
Impuesto del artículo en venta (El 8% solo aplica para quienes lo tienen habilitado)


 Enum: "EXEMPT" "8" "16"  
required
object
Información del SAT


 
object
Identificadores


 
group_ids
required
Array of strings (id)   non-empty 
Identificador del grupo


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Grupos


Puedes implementar estos IDs para búsqueda de estudiantes solicitantes:                






Valor
Descripción





SOLICIT0
Solicitante





 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/store/items
Request samples 
application/json
{
  • "title": "Articulo en venta",
  • "description": "Descripción del nuevo artículo",
  • "name_in_invoices": "ART-02",
  • "barcode": "0987654321",
  • "price": 200,
  • "is_payment_entry": true,
  • "is_online_store": false,
  • "datasheet": {
    },
  • "tax": "16",
  • "sat": {
    },
  • "identifier": {
    },
  • "group_ids": [
    ]
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AWDSFER4",
  • "message": "Item added"
}
Obtener Artículo en venta por ID
Obtener información de los articulos en venta


Request 
path Parameters
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  WADFERF3
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/store/items/{item_id}
Request samples 
Response samples 
application/json
{
  • "id": "AWDSFER4",
  • "title": "Artículo en venta",
  • "description": "Artículo en venta para la tienda online",
  • "name_in_invoices": "ART-01",
  • "barcode": "1234567890",
  • "price": "150.00",
  • "is_active": true,
  • "is_payment_entry": false,
  • "is_online_store": true,
  • "datasheet": { },
  • "tax": "16",
  • "sat": {
    },
  • "identifier": {
    },
  • "history": {
    },
  • "groups": [
    ]
}
Actualizar artículo en venta
Actualizar un artículo en venta


Request 
path Parameters
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del estudiante


 
 Example:  WADFERF3
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
title
string  [ 1 .. 120 ] characters 
Título del artículo en venta


 
description
string
Descripción del artículo en venta


 
name_in_invoices
string  <= 120 characters 
Nombre del artículo en venta dentro de facturas


 
barcode
string  <= 30 characters 
Código de barras del artículo en venta


 
price
number (number) ^\d+(\.\d{1,2})?$
Precio del artículo en venta


 
is_payment_entry
boolean
Indica si el artículo es una entrada de pago


 
is_online_store
boolean
Indica si el artículo está disponible en la tienda en línea


 
is_active
boolean
Indica si el artículo en venta esta activo


 
object
Información de la ficha técnica


 
tax
string
Impuesto del artículo en venta (El 8% solo aplica para quienes lo tienen habilitado)


 Enum: "EXEMPT" "8" "16"  
object
Información del SAT


 
object
Identificadores


 
group_ids
Array of strings (id)   non-empty 
Identificador del grupo


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Grupos


Puedes implementar estos IDs para búsqueda de estudiantes solicitantes:                






Valor
Descripción





SOLICIT0
Solicitante





 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/store/items/{item_id}
Request samples 
application/json
{
  • "title": "Articulo en venta",
  • "description": "Descripción del nuevo artículo",
  • "name_in_invoices": "ART-02",
  • "barcode": "0987654321",
  • "price": 200,
  • "is_payment_entry": true,
  • "is_online_store": false,
  • "is_active": true,
  • "datasheet": {
    },
  • "tax": "16",
  • "sat": {
    },
  • "identifier": {
    },
  • "group_ids": [
    ]
}
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Updated item data"
}
Obtener inventarios
Obtener información de cada inventario


Request 
path Parameters
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del artículo de venta


 
 Example:  LKMDE34E
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


get/store/items/{item_id}/stocks
Request samples 
Response samples 
application/json
[
  • {
    }
]
Agregar inventario
Agregar un nuevo inventario al artículo de venta


Request 
path Parameters
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del artículo de venta


 
 Example:  LKMDE34E
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
provider_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del proveedor


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Contactos


 
date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
 Default:  "now"
Fecha de la entrada de inventario


 
total_price
required
number (number) ^\d+(\.\d{1,2})?$
Precio total del artículo en venta


 
quantity
required
integer  >= 1 
Cantidad de artículos de venta


 
notes
string
Notas de la entrada del inventario


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/store/items/{item_id}/stocks
Request samples 
application/json
{
  • "provider_id": "34DF34KA",
  • "date": "18/12/2024",
  • "total_price": 100,
  • "quantity": 10,
  • "notes": "Ingreso de inventario"
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "AOP345R4",
  • "message": "Stock added successfully"
}
Actualizar inventario
Actualizar información del inventario de un artículo en venta


Request 
path Parameters
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del artículo de venta


 
 Example:  LKMDE34E
stock_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del inventario


 
 Example:  AOP345R4
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
type
string
 Default:  "INCOME"
Tipo de inventario






Valor
Descripción





INCOME
Modificar inventario agregado




DROP
Modificar inventario eliminado





 
provider_id
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del proveedor


Puedes encontrar más información sobre cómo obtenerlo en la documentación de Contactos


 
date
string (date) ^(0[1-9]|[12][0-9]|3[01])/(0[1-9]|1[0-2])/\d{...
 Default:  "now"
Fecha de la entrada de inventario


 
total_price
number (number) ^\d+(\.\d{1,2})?$
Precio total del artículo en venta


 
quantity
integer  >= 1 
Cantidad de artículos de venta


 
notes
string
Notas de la entrada del inventario


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


patch/store/items/{item_id}/stocks/{stock_id}
Request samples 
application/json
{
  • "provider_id": "34DF34KA",
  • "date": "18/12/2024",
  • "total_price": 100,
  • "quantity": 10,
  • "notes": "Ingreso de inventario"
}
Response samples 
application/json
{
  • "details": [ ],
  • "message": "Stock updated successfully"
}
Baja de inventario
Baja de inventario


Request 
path Parameters
item_id
required
string (id)   = 8 characters ^[A-Z0-9]{8}$
Identificador único del artículo de venta


 
 Example:  LKMDE34E
header Parameters
algebraix-api-token
required
string  = 32 characters 
ALGEBRAIX API KEY


 
 Example:  52ffa931bfe0b15415e548672837315e
algebraix-debug-mode
boolean
 Default:  false
La instancia debug se puede utilizar para hacer pruebas sin afectar a los usuarios del sistema


NOTA: La instancia se crea desde web.


 
Request Body schema: application/json
required
quantity
required
integer  >= 1 
Cantidad a restar del inventario


 
notes
string
Notas de la baja del inventario


 
Responses 
200
No error


400
Bad parameters


401
Authorization Required


post/store/items/{item_id}/stocks/drop
Request samples 
application/json
{
  • "quantity": 10,
  • "notes": "Baja de inventario"
}
Response samples 
application/json
{
  • "details": [ ],
  • "id": "PO34FD34",
  • "message": "Stock dropped successfully"
}
➔ Next to Correo de bienvenida