Introducción

Bienvenido a la documentacion de la API de Grupo CVA. Nuestra API proporciona una serie de endpoints diseñados para facilitar la integración y el acceso a nuestros servicios de manera eficiente y segura.

Esta API está basada en nuestra anterior API CVA WEB SERVICE.

Conecta tu página con nuestro Web Service y obtén en tiempo real, inventarios, precios, promociones, descripción e imágenes de producto. Ofrecemos los datos en formato JSON.

Consideraciones

Se recomienda realicen todas tus transacciones en línea (es decir que no hagas una descarga de todo el catálogo una sola vez, si no realizar las consultas al momento) porque aunque hasta el momento no hay, puede haber promociones que tengan vencimiento por hora y está en nuestro ámbito implementarlo, ustedes a través del campo de vencimiento quedan avisados de la expiración, además se darían cuenta cuando una promoción dejo de existir porque las existencias hayan agotado.

Para optimizar el rendimiento y reducir el consumo de ancho de banda, este servicio utiliza un sistema de paginación. Esto permite dividir los resultados en segmentos más pequeños, facilitando su manejo y mejorando la eficiencia de las consultas.

Nuestro catálogo es muy amplio y se encuentra en crecimiento constante, una consulta de esta información puede llegar a medir hasta 90 MB y consumirá ancho de banda tanto de su empresa como la nuestra, sin embargo si su aplicación así lo requiere existe este método. Evítelo en la manera que te sea posible, consulte con su programador para hacer consultas específicas.

** Al utilizar el Webservice acepta el funcionamiento del mismo y que las promociones, existencias, precios y disponibilidad puede cambiar sin previo avisa, por lo que se recomienda siempre consultar en tiempo real.

Autenticación

Peticíon para generar un token:

curl --request POST \
    --url https://apicvaservices.grupocva.com/api/v2/user/login \
    --header 'Content-Type: application/json' \
    --data '{
        "user": "USUARIO",
        "password": "CONTRASEÑA"
    }'

Retorna un JSON con la siguiente estructura:

{
    "usuario": {
        "id_cliente": 666,
        "clave_cliente": 66666,
        "usuario": "USUARIO"
    },
    "token": "TU_API_TOKEN"
}

Para poder acceder a los endpoints que listan productos, necesitas generar un token de autorización.

Parametros del cuerpo de la petición

Parametro	Tipo	Descripción
user	string	Tu usuario CVA
password	string	La contraseña de tu usuario

Pasos a seguir

Generar el token: Antes de hacer cualquier solicitud a los endpoints de productos, asegúrate de haber generado tu token.
Enviar el token: Cuando hagas la solicitud, incluye el token en la cabecera de todas tus solicitudes "Authorization" utilizando el esquema "Bearer".

Como lo siguiente:

Authorization: Bearer TU_API_TOKEN

Tienes que reemplazar TU_API_TOKEN con tu token personal.

Paginación

Peticíon de ejemplo consultando la página 3:

curl --request POST \
    --url https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?page=3 \
    --header 'Content-Type: application/json' \
    --data '{
        "user": "USUARIO",
        "password": "CONTRASEÑA"
    }'

Retorna un JSON con la siguiente estructura:

{
    "articulos": [
        { ... },
        { ... },
        ...
    ],
    "paginacion": {
        "total_paginas": 290,
        "pagina": 3 #Indica la página en la que se encuentra
    }
}

⚠️ Mensaje de error de paginación

{
    "message": "No se encontraron productos."
}

Cuando una consulta a la API devuelve más de un elemento, la respuesta se organiza en una lista paginada. Cada página contiene un máximo de 36 elementos. Para acceder a la totalidad del catálogo, es necesario avanzar a través de las páginas disponibles hasta llegar al límite.

Parametros del cuerpo de la petición

Parametro	Tipo	Default	Descripción
page	int	1	Página que se quiere consultar

Filtro de productos

Catálogo completo

Peticíon para obtener la lista de precios:

curl --request GET \
  --url 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios' \
  --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
  "articulos": [
    {
      "id": 10431032,
      "clave": "SWS-5678",
      "codigo_fabricante": "HW-POS-NST1789I5-W-8GB/240GB",
      "descripcion": "SOFT RESTAURANT PUNTO DE VENTA POS 17 PULG/CORE I5/8GB RAM/240GB SSD/WINDOWS/VESA",
      "principal": "SOFTWARE",
      "grupo": "SOFTWARE",
      "disponible": 0,
      "marca": "SOFT RESTAURANT",
      "garantia": "SG",
      "clase": "AC",
      "moneda": "Pesos",
      "precio": 15877.44,
      "imagen": "https://www.grupocva.com/detalle_articulo/10431032.jpg",
      "disponibleCD": 0
    },
    ... Más artículos
  ]
}

Este endpoint retorna la lista de los productos de catálogo disponibles.

Petición https

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios

Authorization Bearer TU_API_TOKEN

Parametros de la query (Query parameters)

Puntos a considerar

Si se llama el endpoint sin ningún parametro, se asume que usted quiere consultar el cátalogo de productos completo.
Es importante mencionar que los parametros "codigo" y "clave" retornarán solamente el producto que está buscando teniendo más peso "clave".

Parametro	Tipo	Descripción
codigo	string	Código CVA del producto
clave	string	Código del fabricante (Número de parte)
marca	string	Nombre de la marca (Véase) Marcas
grupo	string	Nombre del grupo (Véase) Grupos
desc	string	Buscar mediante cadena de texto libre
porcentaje	float	Le incrementa el porcentaje indicado al precio, para calcular utilidad
MonedaPesos	bool	regresa el precio de todos los productos en pesos méxicanos (deprecado)
subgrupo	bool	Regresa el subgrupo del producto
dt	bool	Regresa la descripción técnica
dc	bool	Rregresa la descripción comercial
TipoProducto	bool	Regresa el tipo de producto, si es producto o paquete
depto	bool	Regresa el departamento al que pertenece
codigosat	bool	Regresa la información que el SAT requiere del
page	int	Número de página que quieres consultar de la respuesta

Ejemplo de busqueda con parametros

Si desea buscar por uno o varios de los parámetros listados anteriormente, debe agregarlos a la URL en forma de query. Por ejemplo, si quiere filtrar sus resultados por la marca Apple, debe especificarlo en la petición de la siguiente manera:

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=apple

De esta manera usted puede buscar de una forma más especifica lo que busca

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=hp&grupo=impresoras&codigosat=true

** Esta petición retornará las impresoras de la marca HP, con su información SAT.

Producto individual

Buscar un producto en específico

# Busqueda por clave
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PR-2586' \
      --header 'Authorization: Bearer TU_API_TOKEN'

# Busqueda por número de pieza
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?codigo=6QN28A#BGJ' \
      --header 'Authorization: Bearer TU_API_TOKEN'

Cuando la búsqueda sea exitosa se retorna una respuesta como la siguiente:

{
    "id": 10412212,
    "clave": "PR-2586",
    "codigo_fabricante": "6QN28A#BGJ",
    "descripcion": "IMPRESORA HP OPS ENTERPRISE 5700DN, 45 PPM NEGRO/ COLOR, LASERJET, DUPLEX, USB, ETHERNET,BLUETOOTH, WIFI-DIRECT(SUSTITUTO M555DN)",
    "principal": "IMPRESION",
    "grupo": "IMPRESORAS",
    "disponible": 3,
    "marca": "HP",
    "garantia": "1 AÑO",
    "clase": "AC",
    "moneda": "Pesos",
    "precio": 16597.83,
    "imagen": "https://www.grupocva.com/detalle_articulo/10412212.jpg",
    "disponibleCD": 6
}

A diferencia del el anterior, si se envía como parámetro la clave CVA o el código del fabricante, el sistema asume que se desea obtener la información de ese producto en específico.

Ejemplo de busqueda

Busca por clave

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PR-2586

Se está buscando especificamente el producto con la clave interna de CVA "PR-2586"

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
clave	string	clave que se desea búscar	null

Busca por pieza

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?codigo=6QN28A#BGJ

Se está buscando especificamente el producto por el número de pieza del fábricante "6QN28A#BGJ"

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
codigo	string	código de fabricante que se desea búscar	null

Por marca

Buscar productos por marca

# Obtiene los productos de la marca Acteck
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=acteck' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "articulos": [
        {
            "id": 10427123,
            "clave": "CS-978",
            "codigo_fabricante": "AC-935708",
            "descripcion": "GABINETE ACTECK VIKEN GM434 / MEDIA TORRE / MICRO ATX, MINI ITX / FUENTE 500W / ILUMINACION RGB / PANEL CRISTAL TEMPLADO, METAL / BLANCO / AC-935708",
            "principal": "COMPONENTES",
            "grupo": "GABINETES",
            "disponible": 3,
            "marca": "ACTECK",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 637.26,
            "imagen": "https://www.grupocva.com/detalle_articulo/10427123.jpg",
            "disponibleCD": 0
        },
        ... más articulos
    ]
}

Con el parámetro marca, por ejemplo, ACTECK, se obtienen todos los productos de esa marca.

Consulte el catálogo de marcas para consultar todas las opciones.

https Request

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=acteck

Este parámetro no distingue entre mayúsculas y minúsculas, por lo que puede realizar su búsqueda independientemente del uso de letras minúsculas o mayúsculas.

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
marca	string	Marca que se desea búscar	null

Producto completo

Buscar sólo productos que tengan sus imágenes completas

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?images=1&completos=1' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente: (El nodo de imágenes de alta resolución siempre tiene imágenes)

{
    "articulos": [
        {
            "id": 10447222,
            "clave": "MNL-2808",
            "codigo_fabricante": "32GS60QC",
            "descripcion": "MONITOR LG ULTRAGEAR 32GS60QC GAMER CURVO QHD 31.5,PANEL VA, 2560X1440, 180HZ, TR 1MS, CURVATURA 1000R, HDR10, AMD FREESYNC, ASPECTO 16:09, CONTRASTE 3000:1, DISPLAYPORT, HDMI, MONTAJE 100X100",
            "principal": "COMPONENTES",
            "grupo": "MONITORES",
            "disponible": 0,
            "marca": "LG",
            "garantia": "SG",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 5285.87,
            "brand_image": "https://me2.grupocva.com/me/imagen/logos/brand_logo.php?id=174",
            "imagen": "https://me2.grupocva.com/me/imagen/imagen_art_detalles.php?fProd=10447222",
            "disponibleCD": 0,
            "promociones": null,
            "imagenes": [
                "https://www.grupocva.com/detalle_articulo/img_large.php?id=360946",
                "https://www.grupocva.com/detalle_articulo/img_large.php?id=360948",
                "https://www.grupocva.com/detalle_articulo/img_large.php?id=360970",
                "https://www.grupocva.com/detalle_articulo/img_large.php?id=360972",
                "https://www.grupocva.com/detalle_articulo/img_large.php?id=360990"
            ]
        },
        ... más articulos
    ]
}

Al activar este parámetro, el sistema filtra y recupera exclusivamente aquellos productos que se consideran completos, es decir, que cuentan con imágenes de alta resolución. Este filtro excluye automáticamente los productos que no disponen de imágenes asociadas, garantizando que los resultados obtenidos cumplan con los estándares de calidad y presentación requeridos.

Petición

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?images=1&completos=1

⚠️ El parámetro completos puede utilizarse de manera independiente; sin embargo, está pensado para emplearlo en conjunto con el parámetro images. Esta combinación permite recuperar no solo los productos completos, sino también las imágenes asociadas a cada uno de ellos. De esta manera, se asegura que el nodo correspondiente al producto siempre incluya al menos una imagen, garantizando la integridad y calidad de la información proporcionada.

Query Parameters

Parametro	Tipo	Valor por defecto
completos	bool	false

Por grupo

Buscar productos por grupo

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?grupo=bocinas' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "articulos": [
        {
            "id": 10431052,
            "clave": "SPK-2527",
            "codigo_fabricante": "72D1AA",
            "descripcion": "ALTAVOZ MANOS LIBRES HP POLY 72D1AA SYNC20+ M /VERSION MICROSOFT TEAMS USB-C PORTATIL CONECTIVIDAD USB Y BLUETOOTH IP64 BATERIA HASTA 20 H",
            "principal": "AUDIO",
            "grupo": "BOCINAS",
            "disponible": 1,
            "marca": "POLY",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Dolares",
            "precio": 157.79,
            "imagen": "https://www.grupocva.com/detalle_articulo/10431052.jpg",
            "disponibleCD": 0
        },
        ... más articulos
    ]
}

Con el parámetro grupo, por ejemplo, "Bocinas", se obtienen todos los productos que pertenezcan a ese grupo.

Consulte el catálogo de grupos para consultar todas las opciones.

https Request

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?grupo=bocinas

Este parámetro no distingue entre mayúsculas y minúsculas, por lo que puede realizar su búsqueda independientemente del uso de letras minúsculas o mayúsculas.

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
grupo	string	Grupo que se desea búscar	null

Por grupo2

Buscar productos por grupo2

# Obtiene los productos del grupo con ID 268
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?grupo2=268' \
      --header 'Authorization: Bearer TU_API_TOKEN'

# Obtiene los productos de los grupos 268 y 15462 este filtro combina bocinas con el subgrupo bafle
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?grupo2=268,15462' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "articulos": [
        {
            "id": 10431052,
            "clave": "SPK-2527",
            "codigo_fabricante": "72D1AA",
            "descripcion": "ALTAVOZ MANOS LIBRES HP POLY 72D1AA SYNC20+ M /VERSION MICROSOFT TEAMS USB-C PORTATIL CONECTIVIDAD USB Y BLUETOOTH IP64 BATERIA HASTA 20 H",
            "principal": "AUDIO",
            "grupo": "BOCINAS",
            "disponible": 1,
            "marca": "POLY",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Dolares",
            "precio": 157.79,
            "imagen": "https://www.grupocva.com/detalle_articulo/10431052.jpg",
            "disponibleCD": 0
        },
        {
            "id": 10426372,
            "clave": "SPK-2495",
            "codigo_fabricante": "PC-114017",
            "descripcion": "BAFLE BLUETOOTH INALAMBRICO 8 CON MICROFONO INCLUIDO Y LUZ RGB JOY PERFECT CHOICE",
            "principal": "AUDIO",
            "grupo": "BOCINAS",
            "disponible": 8,
            "marca": "PERFECT CHOICE",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 1714.27,
            "imagen": "https://www.grupocva.com/detalle_articulo/10426372.jpg",
            "disponibleCD": 6
        },
        ... más articulos
    ]
}

Con el parámetro grupo2, es otra manera de buscar por grupos, pero a diferencia de la manera tradicional, esta opcion te da la oportunidad de concaternar grupos con subgrupos.

Ten en cuenta que para buscar con el parametro grupo2, se manda el ID del/os grupos a consultar separados por coma ",".

Ejemplos con https Request

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?grupo2=268

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?grupo2=268,15462

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
grupo2	string	IDS de grupos a buscar separados por comas	null

Por búsqueda genérica

Buscar productos por búsqueda genérica

# Obtiene los productos que contengan en la descripción la palabra "GAMING"
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?desc=GAMING' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "articulos": [
        {
            "id": 10430953,
            "clave": "NOT-9804",
            "codigo_fabricante": "82XV00PRLM",
            "descripcion": "LAPTOP LENOVO IDEA GAMING LOQ 15IRH8 / CORE I5-12450H / 8GB DDR5 / 512GB SSD / RTX 2050 4GB / 15.6 FHD (1920X1080) / STORM GREY / WIN 11 HOME / 1 YR CS",
            "principal": "COMPUTADORAS",
            "grupo": "PORTATILES",
            "disponible": 0,
            "marca": "LENOVO",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 12873.6,
            "imagen": "https://www.grupocva.com/detalle_articulo/10430953.jpg",
            "disponibleCD": 0
        },
        {
            "id": 10427317,
            "clave": "MS-1605",
            "codigo_fabricante": "CH-9319511-NA2",
            "descripcion": "MOUSE CORSAIR M65 RGB ULTRA WIRELESS /LED/ INALAMBRICO / OPTICO / 26000 DPI / GAMING/ WHITE",
            "principal": "COMPONENTES",
            "grupo": "MOUSE",
            "disponible": 1,
            "marca": "CORSAIR",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Dolares",
            "precio": 98.17,
            "imagen": "https://www.grupocva.com/detalle_articulo/10427317.jpg",
            "disponibleCD": 0
        },
        ... más articulos
    ],
}

Con el parámetro desc, puedes realizar búsquedas genéricas (realiza la búsqueda dentro de la descripcion corta de producto). Ejemplo: una búsqueda genérica que contenga la palabra clave GAMING.

Ejemplos con https Request

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?desc=GAMING

Este parámetro no distingue entre mayúsculas y minúsculas, por lo que puede realizar su búsqueda independientemente del uso de letras minúsculas o mayúsculas.

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
desc	string	Palabra clave que se buscará en la descripcion de los productos	null

Por solución

Buscar productos por solución

# Obtiene los productos que contengan en la descripción la palabra "GAMING"
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=acteck&Solucion=21' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "articulos": [
        {
            "id": 10407154,
            "clave": "AC-11776",
            "codigo_fabricante": "AC-936590",
            "descripcion": "SOPORTE ACTECK VAULT STATION BD414 / BASE PARA DIADEMA Y CONTROL / SILICON / ANTIDESLIZANTE / AJUSTABLE / NEGRO / AC-936590",
            "principal": "ACCESORIOS",
            "grupo": "ACCESORIOS",
            "disponible": 0,
            "marca": "ACTECK",
            "garantia": "SG",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 194.37,
            "imagen": "https://www.grupocva.com/detalle_articulo/10407154.jpg",
            "disponibleCD": 27
        },
        {
            "id": 10361512,
            "clave": "AC-10931",
            "codigo_fabricante": "AC-934992",
            "descripcion": "BARRA DE LUZ PARA LAPTOP Y MONITOR LUMINATE SHADE BL460 / ULTRA DELGADO / USB C / NEGRO/ ADVANCED SERIES / AC-934992",
            "principal": "ACCESORIOS",
            "grupo": "ACCESORIOS",
            "disponible": 5,
            "marca": "ACTECK",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 265.88,
            "imagen": "https://www.grupocva.com/detalle_articulo/10361512.jpg",
            "disponibleCD": 0
        }
    ],
    ...
}

Usando el parámetro Solucion=(ID de Solucion), puedes filtrar productos específicos según la solución deseada. Para consultar el ID de cada solución, revisa el catálogo de Soluciones.

Por ejemplo, al utilizar Solucion=21 y marca=Acteck, la consulta filtrará los productos de la categoría "Gamer" que pertenecen a la marca Acteck.

Consulte el catálogo de soluciones para consultar todas las opciones.

Ejemplos con https Request

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=acteck&Solucion=21

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
Solucion	int	Este parametro aplicará el filtro con la solución	null

Filtro de disponibilidad

Productos con disponibilidad

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?exist=2' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "articulos": [
        {
            "id": 10448038,
            "clave": "NOT-10099",
            "codigo_fabricante": "21MM0017LM",
            "descripcion": "LAPTOP LENOVO THINKPAD T14 GEN 5 / CORE ULTRA 7 155U 4.8GHZ / 32GB DDR5 5600 / 1TB SSD / 14 WUXGA (1920X1200) / WIN 11 PRO / 3YR PREMIER SUPPORT",
            "principal": "COMPUTADORAS",
            "grupo": "PORTATILES",
            "disponible": 0,
            "marca": "LENOVO",
            "garantia": "3 AÑOS",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 26293.33,
            "brand_image": "https://me2.grupocva.com/me/imagen/logos/brand_logo.php?id=173",
            "imagen": "https://me2.grupocva.com/me/imagen/imagen_art_detalles.php?fProd=10448038",
            "disponibleCD": 12, <--- con disponibilidad (filtro exist = 2)
            "promociones": null
        },
        ....
    ]
}

Usted tiene la posibilidad de configurar el servicio para que muestre el catálogo de productos de acuerdo con la disponibilidad en inventario. Puede elegir entre las siguientes opciones:

1. Filtrar por disponibilidad en la sucursal: El servicio mostrará únicamente los productos que estén disponibles en la sucursal donde usted fue registrado como cliente.

2. Filtrar por disponibilidad en el centro de distribución (CEDIS): El servicio mostrará solo los productos disponibles en el CEDIS asociado a su sucursal.

3. Filtrar por disponibilidad en sucursal o CEDIS: El servicio mostrará los productos que estén disponibles tanto en la sucursal como en el CEDIS.

Por defecto, el servicio mostrará todos los productos sin aplicar filtros de disponibilidad.

Parametro	Tipo	valor	reglas de filtro
exist	int	0 (default)	No aplica ningún flitro de disponibilidad.
exist	int	1	Muestra lo que tenga disponible en la sucursal (independiente del CEDIS).
exist	int	2	Muestra lo que tenga disponible en el CEDIS (independiente de la sucursal).
exist	int	3	Muestra lo que tenga disponible en la sucursal o en el CEDIS.

Imágen ilustrativa

Flujo de disponibilidad

Significado de cada propiedad de disponibilidad

propiedad	significado
disponible	Indica la cantidad de existencias disponibles en la sucursal donde el usuario está registrado.
disponibleCD	Representa la cantidad de existencias disponibles en el centro de distribución (CEDIS) que abastece a la sucursal del usuario.
disponibilidad_sucursales	Refleja la cantidad total de existencias disponibles en todas las sucursales CVA.

Parametros adicionales

Precio especial ME

# Obtiene los productos que contengan en la descripción la palabra "GAMING"
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PR-2586&TipoCompra=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    {
    "id": 10412212,
    "clave": "PR-2586",
    "codigo_fabricante": "6QN28A#BGJ",
    "descripcion": "IMPRESORA HP OPS LASERJET ENTERPRISE 5700DN, 45 PPM NEGRO/ COLOR, LASER COLOR, USB, WIFI, ETHERNET (RED), DUPLEX, ADF, BLUETOOTH (SUSTITUTO M555DN)",
    "principal": "IMPRESION",
    "grupo": "IMPRESORAS",
    "disponible": 0,
    "marca": "HP",
    "garantia": "1 AÑO",
    "clase": "AC",
    "moneda": "Pesos",
    "precio": 16930.58, <--- Precio especial
    "imagen": "https://www.grupocva.com/detalle_articulo/10412212.jpg",
    "disponibleCD": 6
}
}

Los productos tienen un precio especial cuando se ordenan a través del sistema ME. Para que el Webservice muestre este precio, debes utilizar el parámetro TipoCompra = true. Por defecto, se muestran los precios aplicables al levantar los productos en la sucursal.

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
TipoCompra	bool	Activa el precio especial ME	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Porcentaje de útilidad

Agregar porcentaje

# Obtiene los productos que contengan en la descripción la palabra "GAMING"
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PR-2586&porcentaje=16' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "id": 10412212,
    "clave": "PR-2586",
    "codigo_fabricante": "6QN28A#BGJ",
    "descripcion": "IMPRESORA HP OPS ENTERPRISE 5700DN, 45 PPM NEGRO/ COLOR, LASERJET, DUPLEX, USB, ETHERNET,BLUETOOTH, WIFI-DIRECT(SUSTITUTO M555DN)",
    "principal": "IMPRESION",
    "grupo": "IMPRESORAS",
    "disponible": 3,
    "marca": "HP",
    "garantia": "1 AÑO",
    "clase": "AC",
    "moneda": "Pesos",
    "precio": 19253.48,
    "imagen": "https://www.grupocva.com/detalle_articulo/10412212.jpg",
    "disponibleCD": 6
}

Con el parámetro porcentaje, permite aumentar un porcentaje sobre nuestro precio para calcular su utilidad.

Ejemplos con https Request

Subir porcentaje de 16% al producto con clave PR-2586, lo que aumentará directamente en el nodo "precio" del producto ese porcentaje.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PR-2586&porcentaje=16

Aplicar porcentaje a lista de productos

Aplicar el paramerametro en consultas que retornan más de un nodo aumentará el porcentaje sobre el precio en todos los nodos de la respuesta.

https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PR-2586&porcentaje=16

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
porcentaje	int	Le incrementa el porcentaje indicado al precio, para calcular utilidad	null

Promociones

Promociones:

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=ghia&promos=true' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON la llave "promociones":

{
    "articulos": [
        {
            "id": 10430092,
            "clave": "PCGHIA-3454",
            "codigo_fabricante": "AMD RYZEN SERIES",
            "descripcion": "GHIA FRONTIER SLIM 2.0 / AMD RYZEN 5 5600GT MAX 4.6 GHZ / RAM 8 GB / SSD NVME 1 TB / WIN 11 PRO",
            "principal": "COMPUTADORAS",
            "grupo": "PC´S",
            "disponible": 0,
            "marca": "GHIA",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 8443.89,
            "imagen": "https://www.grupocva.com/detalle_articulo/10430092.jpg",
            "disponibleCD": 0,
            "promociones": {
                "total_descuento": 10,
                "moneda_descuento": "Dolares",
                "precio_descuento": 8250.59,
                "moneda_precio_descuento": "Pesos",
                "clave_promocion": 608796,
                "descripcion_promocion": "\"¡Actualiza tu poder! Descuentos en equipos con procesadores AMD Ryzen, promocion sujeta a unidades",
                "promocion_vencimiento": "28/09/2024",
                "disponible_en_promocion": 0
            }
        },
        ...
    ]
}

En CVA, manejamos una lista de promociones disponibles para nuestros productos. Si un producto tiene más de una promoción aplicable, siempre seleccionamos la que ofrece el mejor descuento. Para activar la aplicación de promociones, utiliza el parámetro promos = true

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
promos	bool	Mostrará la información de la promoción que se encontró	false

Ejemplos https REQUEST

Obtener todos los productos de la marca "GHIA", con sus promociones.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=ghia&promos=true

Obtener el producto con clave "PCGHIA-3454", con sus promociones.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PCGHIA-3454&promos=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

⚠️ No todos los productos tienen promociones, por lo que algunos regresan el valor null en su lugar.

IMPORTANTE

Toma lo siguiente en cuenta con las promociones:

** Al utilizar el Webservice usted acepta el funcionamiento del mismo y que las promociones, existencias, precios y disponibilidad puede cambiar sin previo aviso, por lo que se recomienda siempre consultar en tiempo real.

Cambiar precio a pesos

Obtener productos con precio en pesos mexicanos:

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=ocelot%20gaming&MonedaPesos=true' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición modificará a la respuesta JSON la llave "precio":

{
    "articulos": [
        {
            "id": 10415032,
            "clave": "CS-947",
            "codigo_fabricante": "BLUE WARTHOG",
            "descripcion": "GABINETE OCELOT GAMING BLANCO MODELO Y DISEÑO ANIME BLUE WARTHOG/MEDIA TORRE/SOPORTA 8 VENTILADORES DE 120MM/SOPORTA GPU 3400MM/CRISTAL TEMPLADO/SIN FUENTE/FACTOR DE FORMA ATX/ FRONTAL LISO.",
            "principal": "COMPONENTES",
            "grupo": "GABINETES",
            "disponible": 2,
            "marca": "OCELOT GAMING",
            "garantia": "1 AÑO",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 755.76,
            "imagen": "https://www.grupocva.com/detalle_articulo/10415032.jpg",
            "disponibleCD": 108
        },
        ...
    ]
}

Parámetro Deshabilitado Temporalmente

Si requieres todos los precios en pesos mexicanos ya que algunos productos tienen el precio en dólares.

MonedaPesos = true retorna los productos en MN con el tipo de cambio actual.

Se recomienda usar el parámetro aunado al parámetro tc = true para ver el tipo de cambio. Ver

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
MonedaPesos	bool	Cambia el precio a pesos (Si estan en dólares)	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

⚠️ No todos los productos tienen promociones, por lo que algunos regresan el valor null en su lugar.

Manejo de paquetes

Ejemplo de solicitud

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PAQ-586&TipoProducto=true' \
     --header 'Authorization: Bearer TU_API_TOKEN'

Respuesta completa

{
    "id": 10132410,
    "clave": "PAQ-586",
    "codigo_fabricante": "DELL",
    "descripcion": "Kit Teclado KB-645 Mouse MS-1105",
    "principal": null,
    "grupo": null,
    "disponible": 0,
    "marca": null,
    "garantia": "SG",
    "clase": "AC",
    "moneda": "Pesos",
    "precio": 307.52,
    "imagen": "https://www.grupocva.com/detalle_articulo/10132410.jpg",
    "disponibleCD": 0,
    "producto_paquete": {
        "tipo": "PAQUETE",
        "componentes": "MS-1105, KB-645"
    }
}

La logística de CVA establece que los paquetes no siempre tienen marca, grupo o clasificadores generales. Estos clasificadores son más comunes en los productos individuales. Al agregar el parámetro TipoProducto = true, se determina si se muestra el campo "producto_paquete".

Campo producto_paquete:

Si el producto es simple, el valor será PRODUCTO.
Si el producto es un paquete, el valor será PAQUETE.

Parametro	Tipo	Descripción	Valor por defecto
TipoProducto	bool	Mostrará la información del paquete en caso de que lo sea.	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Elemento componentes

campo que se le añadio

"producto_paquete": {
        "tipo": "PAQUETE",
        "componentes": "MS-1105, KB-645"
}

Este elemento lista los productos que conforman el paquete (cuando valor es PAQUETE), permitiendo al usuario listar las claves CVA de cada componente que conforma el pedido.
Los elementos dentro del campo "componentes", siempre son claves CVA.

Disponibilidad en sucursales

Disponibilidad en sucursales

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=CV-1856&sucursales=true' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "articulos": [
        {
            ... campos adicionales
            "disponibilidad_sucursales": [
                {
                    "nombre": "MEXICO CENTRO DE DISTRIBUCION",
                    "disponible": 0
                },
                {
                    "nombre": "MONTERREY CENTRO DE DISTRIBUCION",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS CANCUN",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS CHIHUAHUA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS COLIMA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS CULIACAN",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS DF TALLER",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS HERMOSILLO",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS LEON",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS MERIDA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS MONTERREY",
                    "disponible": 10
                },
                {
                    "nombre": "VENTAS MORELIA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS OAXACA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS PACHUCA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS PUEBLA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS QUERETARO",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS TEPIC",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS TOLUCA",
                    "disponible": 5
                },
                {
                    "nombre": "VENTAS TORREON",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS TUXTLA",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS VERACRUZ",
                    "disponible": 0
                },
                {
                    "nombre": "VENTAS VILLAHERMOSA",
                    "disponible": 0
                },
                {
                    "nombre": "TOTAL",
                    "disponible": 15
                }
            ]
        },
        ... más productos
    ]

Consulta la disponibilidad de el/los productos en cada una de las sucursales.

Ejemplos con https Request

Busca la disponibilidad en sucursales del producto con clave "CV-1856"

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=CV-1856&sucursales=true

Busca la disponibilidad en sucursales de todos los productos de la marca "ghia"

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=ghia&sucursales=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
sucursales	bool	Mostrará la existencia del producto en cada una de las sucursales	false

** El Precio de un producto puede variar de una sucursal a otra así como el precio del flete depende de la distancia origen y destino.

Subgrupo

Si el parametro subgrupo = true se agrega a la respuesta el nodo en el que indica el subgrupo del producto.

Obtener subgrupo de el/los artículos

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=KB-890&subgpo=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON la llave:

{
    "subgrupo": "GAMERS"
}

Ejemplos https REQUEST

Obtener el subgrupo del producto con clave: KB-890

https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=KB-890&subgpo=true

Obtener el subgrupo de todos los articulos de una lista de productos

https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?subgpo=true

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
subgpo	bool	Mostrará el nombre del subgrupo del producto	false

Mostrar tipo de cambio

Si el parámetro tc = true se añadirán los campos de valor de tipo de cambio de dólar y su última fecha de actualización por nuestra parte, si está en cero o no incluyes el parámetro no se mostrá el elemento en la respuesta.

Mostrar tipo de cambio

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=KB-890&tc=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "tipo_cambio": 18.07,
    "fecha_actualizacion_tipo_cambio": "19/07/2024 11:04:18"
}

Ejemplos https REQUEST

Obtener el producto con clave: KB-890 con su tipo de cambio

https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=KB-890&tc=true

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
tc	bool	Mostrará el tipo de cambio	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Parámetro "tipo"

Si el parámetro tipo = true entonces la API te agregará una llave al JSON de respuesta "TipoProducto" Este es el equivalente para el servicio web de los “productos por salir” estos productos están disponibles solo hasta agotar existencias y no genera backorder o sea que no compran aunque sean solicitados (se ponen por salir porque es posible que ni el proveedor siga surtiendo el producto o este descontinuado), ósea que se debe limitar a ofrecer la existencia mostrada.

Parámetro "tipo"

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&tipo=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "tipo_producto": "EXISTENCIA"
}

Ejemplos https REQUEST

Obtener el producto con clave: SPK-2093 con su tipo de cambio

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&tipo=true

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
tipo	bool	Mostrará el tipo de producto	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Parámetro "Depto"

Parámetro "Depto"

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&depto=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "departamento": {
        "id": 1261,
        "nombre": "POR SALIR"
    }
}

CVA clasifica los productos de acuerdo a su tiempo de vida o de acuerdo a su forma de adquirir o comprar el producto, al activar el parámetro depto = true la respuesta regresará una llave dentro de la respuesta JSON llamada "Departamento" en donde puede contener una serie de nomenclaturas.

Significado de las nomenclaturas

Valor	Significado
A	PRODUCTO CON VENTA ALTA LOS PRODUCTOS TIENEN UNA EXISTENCIA ALTA Y REGULAR EN LAS SUCURSALES.
B	PRODUCTO CON VENTAS MEDIAS LOS PRODUCTOS TIENEN MEDIANA EXISTENCIA Y SU RESURTIDO ES REGULAR.
C	PRODUCTO CON BAJAS VENTAS ESTE PRODUCTO MANTIENE UN INVENTARIO BAJO.
POR SALIR	YA NO SE SURTE Y ESTARA LIMITADA A LAS EXISTENCIAS ACTUALES.
S P C D	SE TIENE EXISTENCIA EN EL CENTRO DE DISTRIBUCION
SPF	PRODUCTOS BAJO PEDIDO.

Ejemplos https REQUEST

Obtener el producto con clave: SPK-2093 con su departamento.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&depto=true

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
depto	bool	Mostrará el departamento del producto	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Descripciones enriquecidas

Descripciones enriquecidas

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&dt=true&dc=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "ficha_tecnica": "HEADSET - MAGENTA ( TIPO DIADEMA ) - TAMANO BOCINA: 40MM- INDEPENDIENCIA: 32 ohms±15%- SENSIBILIDAD: 108 dB±3db- RANGO DE FRECUENCIA: 20Hz 2000Hz- MICROFONO: 6MM X 5MM- SENSIBILIDAD DE MICROFONO: -38dB±3db- INDEPENDENCIA DE MICROFONO: 2200ohms- DIRECCION: TODAS LAS DIRECCIONES- LARGO DE LINEA: 2.2M±15%- VOLTAJE DE TRABAJO DE LED : 5V cc- CORRIENTE DE TRABAJO: 100mA- INTERFAZ DE AURICULAR:  USB+3.5- CONTROL DE AUDIO- MICROFONO RETRACTIL CON CANCELACION DE RUIDO- ADAPTADOR DE AUDIO PARA PC- CABLE CON RECUBRIMIENTO EN NAILON- OREJAS DESMONTABLES - COMPATIBLE CON: XBOX, PLAYSTATION, WINDOWS, ANDROID, LINUX Y MAC- UN ANO DE GARANTIA",
    "ficha_comercial": "JUEGA COMO UN PROFECIONAL CON LOS HEADSET \"OGH03\" DISENADOS PARA UN VERDADERO GAMER.DISFRUTA DEL MEJOR RENDIMINETO DE AUDIO CON LA MEJOR COMODIDAD GRACIAS A SUS ALHOMADILLAS BIEN ALCOCHONADAS QUE TE PERMITEN MANTENER EL RUIDO EXTERIOR AL MINIMO Y DISFRUTAR DE UN SONIDO CLARO, MICROFONO CON CANCELACION DE RUIDO PARA UNA COMUNICACION CLARA MIENTRAS JUEGAS.- COMPATIBLE CON: XBOX, PLAYSTATION, WINDOWS, ANDROID, LINUX Y MAC"
}

Usted tiene la opción de mandar los parametros dt = true y dc = true

El parámetro dt se encarga de agregar la información técnica dentro de la respuesta JSON.

El parámetro dc se encarga de agregar la información comercial dentro de la respuesta JSON.

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
dt	bool	Mostrará la descripción técnica del producto	false
dc	bool	Mostrará la descripción comercial del producto	false

Ejemplos https REQUEST

Obtener el producto con clave: SPK-2093 con sus descripciones.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&dt=true&dc=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

UPC

Agregar UPC a la respuesta del producto

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=PHILIPS&upc=true' \
--header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "upc": "840063202375"
}

Para obtener el UPC (Código Universal de Producto) de producto se debe añadir el parametro upc = true

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
upc	bool	Mostrará el código univesal del producto	false

Ejemplos https REQUEST

Obtener el UPC de los productos de la marca Philips.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?marca=PHILIPS&upc=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Ficha técnica PDF

Agregar ficha tecnica PDF al nodo

curl --location 'http://api-cvaservices.test/api/v2/catalogo_clientes/lista_precios?pdf=true' \
--header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "ficha_tecnica_pdf": srting|null
}

Ejemplo de respuesta:

{
    "articulos": [
        { ... },
        { ... },
        {
            "id": 9682847,
            "clave": "SWS-1990",
            "codigo_fabricante": "TMESET-067",
            "descripcion": "ESET SMALL OFFICE SECURITY, 10 LICENCIAS PCS 1 LICENCIA PARA SERVER WINDOWS CONSOLA LOCAL, 1 AÑO DE VIGENCIA CAJA",
            "principal": "SOFTWARE",
            "grupo": "SOFTWARE",
            "disponible": 13,
            "marca": "ESET",
            "garantia": "SG",
            "clase": "AC",
            "moneda": "Pesos",
            "precio": 1906.4,
            "brand_image": "https://me2.grupocva.com/me/imagen/logos/brand_logo.php?id=10525",
            "imagen": "https://me2.grupocva.com/me/imagen/imagen_art_detalles.php?fProd=9682847",
            "disponibleCD": 56,
            "promociones": null,
            "ficha_tecnica_pdf": "https://apicvaservices.grupocva.com/api/v2/pdf_service/descarga_ficha/9682847"
        }
    ],
    "paginacion": {
        "total_paginas": 1,
        "pagina": 3
    }
}

Para incluir el PDF con la ficha técnica del producto en la respuesta, debe activar el parámetro pdf.

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
pdf	bool	Mostrará el la ficha tecnica PDF en caso de existir	false

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Información SAT

Agregar información del SAT a la respuesta del producto

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=KB-645&codigosat=true' \
--header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

"sat_info": {
    "clave": 43211706,
    "descripcion": "Teclados"
}

Para obtener la descripción del SAT (Servicio de Administración Tributaria) del producto se debe añadir el parametro codigosat = true

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
codigosat	bool	Mostrará el id y la descripción SAT del producto	false

Ejemplos https REQUEST

Obtener la información SAT del producto KB-645.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=KB-645&codigosat=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Imágenes

Imágenes

curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&images=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna la respuesta JSON:

{
    "id": 10253052,
    "clave": "SPK-2093",
    "codigo_fabricante": "OGH03",
    "descripcion": "AUDIFONOS GAMER OCELOT TIPO DIADEMA/OVER-EAR/USB/3.5MM/COLOR ROSA CON NEGRO/ALAMBRICOS/ILUMINACION BLANCA/CONTROL DE AUDIO/MICROFONO CANCELACION DE RUIDO/AJUSTABLES/MULTIPLATAFORMA",
    "principal": "AUDIO",
    "grupo": "AUDIFONOS Y MICRO",
    "disponible": 240,
    "marca": "OCELOT GAMING",
    "garantia": "1 AÑO",
    "clase": "AC",
    "moneda": "Dolares",
    "precio": 19.89,
    "imagen": "https://www.grupocva.com/detalle_articulo/10253052.jpg",
    "disponibleCD": 61,
    "imagenes": [
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=323327",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=323331",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=323330",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=323328",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=323329"
    ],
}

Para obtener imágenes de alta resolución de tu producto tiene que enviar el parámeto images = true.

Esta forma de consultar imágenes resulta más conveniente, sin embargo si sólo requiere lás imágenes sin ninguna información extra, es recomendable usar Imágenes.

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
images	bool	Mostrará el arreglo de imágenes ligadas al producto	false

Ejemplos https REQUEST

Obtener el producto con clave: SPK-2093 con sus imágenes.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=SPK-2093&images=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

⚠️ No todos los productos tienen imágenes, por lo que algunos regresan el valor null

Dimensiones del producto

Agregar porcentaje

# Obtiene los productos que contengan en la descripción la palabra "GAMING"
curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=FRE-6&dimen=true' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    {
    "id": 10367838,
    "clave": "FRE-6",
    "codigo_fabricante": "MFA01",
    "descripcion": "FREIDORA DE AIRE DIGITAL MIRATI CON CAPACIDAD DE 5 LITROS, 7 MODOS PREESTABLECIDOS, TEMPERATURA DE 60C-200C",
    "principal": "PREPARACIÓN DSE ALIMENTOS",
    "grupo": "PREPARACIÓN DSE ALIMENTOS",
    "disponible": 0,
    "marca": "MIRATI",
    "garantia": "1 AÑO",
    "clase": "AC",
    "moneda": "Pesos",
    "precio": 627.41,
    "imagen": "https://www.grupocva.com/detalle_articulo/10367838.jpg",
    "disponibleCD": 0,
    "dimensiones": {
        "medidas": "0.354, 0.336, 0.336",
        "alto": 0.354,
        "ancho": 0.336,
        "profundidad": 0.336,
        "peso": 5,
        "unidad_logitud": "M",
        "unidad_peso": "KG"
    }
}
}

Para consultar las dimensiones de un producto, utiliza el parámetro dimen=1 Este parámetro retornará las dimensiones en metros y el peso en kilogramos.

Query Parameters

Parametro	Tipo	Descripción	Valor por defecto
dimen	bool	si es true, se el endpoint regresa las dimensiones del producto	false

Ejemplos con https Request

Obtener el producto con clave "FRE-6" con sus dimensiones.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=FRE-6&dimen=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Procesador

# Agrega el procesador del producto al nodo en caso de aplicar
curl  --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=PCGHIA-3480&procesador=true' \
      --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "id": 10450943,
    "clave": "PCGHIA-3480",
    "codigo_fabricante": "INTEL CORE SERIES",
    "descripcion": "GHIA FRONTIER SLIM / INTEL CORE I3-13100, 4 NCLEOS MAX 4.50 GHZ / RAM 8 GB / SSD NVME 1 TB / SIN SISTEMA",
    "principal": "COMPUTADORAS",
    "grupo": "PC´S",
    "disponible": 0,
    "marca": "GHIA",
    "garantia": "1 AÑO",
    "clase": "AC",
    "moneda": "Dolares",
    "precio": 1.09,
    "brand_image": null,
    "imagen": "https://me2.grupocva.com/me/imagen/imagen_art_detalles.php?fProd=10450943",
    "disponibleCD": 0,
    "promociones": null,
    "procesador": "INTEL CORE i3" <-- Agrega este nodo
},

Al habilitar este parámetro, se incluirá en la respuesta el nodo del procesador del equipo, siempre y cuando esta información esté disponible y sea aplicable al producto consultado.

Query Parameters

Parametro	Tipo	Valor por defecto	Descripción
procesador	bool	false	Agrega al nodo la información del CPU

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

⚠️ En caso de no encontrar un valor retornara null en el nodo.

Transito a sucursal

Obtener el transito a sucursal

# Obtiene los el tránsito a sucursal
curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=CSP-438&trans=true' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición agrega a la respuesta JSON las llaves:

{
    "en_transito": 3
}

Utilizando el parámetro trans=1 podemos obtener la cantidad en tránsito a la sucursal.

Ejemplos con https Request

Obtener el producto con clave "CSP-438" con su cantidad en tránsito.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/lista_precios?clave=CSP-438&trans=true

✅ Este parámetro se puede aplicar tanto a consultas que retornan un solo producto como a aquellas que devuelven una lista de productos.

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
trans	bool	Mostrará la cantidad en tránsito a la sucursal	false

Información técnica

Obtener la información técnica de un producto

Obtener información técnica del producto

# Obtiene los productos que contengan en la descripción la palabra "GAMING"
curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/informacion_tecnica?clave=RELOJ-27' \
     --header 'Authorization: Bearer TU_API_TOKEN'

La petición retorna un JSON como el siguiente:

{
    "especificaciones": [
        {
            "nombre": "MONITOREA",
            "valor": "CALORIAS"
        },
        {
            "nombre": "MONITOREA",
            "valor": "PASOS "
        },
        {
            "nombre": "LLAMADA ENTRANTE",
            "valor": "SI "
        },
        {
            "nombre": "RESISTENTE AL AGUA",
            "valor": "SI"
        },
        {
            "nombre": "INCLUYE ALTAVOZ",
            "valor": "SI"
        },
        {
            "nombre": "DISPLAY TACTIL",
            "valor": "SI"
        },
        {
            "nombre": "NOTIFICACIONES",
            "valor": "TWITTER"
        },
        {
            "nombre": "NOTIFICACIONES",
            "valor": "SI"
        },
        {
            "nombre": "NOTIFICACIONES",
            "valor": "FACEBOOK"
        },
        {
            "nombre": "NOTIFICACIONES",
            "valor": "LLAMADA ENTRANTE"
        },
        {
            "nombre": "NOTIFICACIONES",
            "valor": "WHATS APP"
        },
        {
            "nombre": "NOTIFICACIONES",
            "valor": "CORREO ELECTRONICO"
        },
        {
            "nombre": "INTERFAZ",
            "valor": "BLUETOOTH"
        },
        {
            "nombre": "COMPATIBILIDAD",
            "valor": "ANDROID 4.3 O SUPERIOR"
        },
        {
            "nombre": "COMPATIBILIDAD",
            "valor": "IOS 8 O SUPERIOR"
        },
        {
            "nombre": "RESOLUCION",
            "valor": "240 X 240 P"
        },
        {
            "nombre": "TIPO DE MATERIAL",
            "valor": "METAL"
        },
        {
            "nombre": "TIPO DE MATERIAL",
            "valor": "HULE"
        },
        {
            "nombre": "DURACION DE BATERIA APROXIMADA",
            "valor": "24 HRS"
        },
        {
            "nombre": "COLOR",
            "valor": "BLANCO"
        },
        {
            "nombre": "TIPO DE PANTALLA",
            "valor": "LCD"
        },
        {
            "nombre": "RESISTENTE A SALPICADURAS",
            "valor": "SI"
        }
    ]
}

Puedes obtener la información técnica de un producto desglosada en sus características principales. Para ello, debes utilizar el parámetro clave.

Ejemplos con https Request

Obtener la información técnica del prodcuto con clave RELOJ-27.

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/informacion_tecnica?clave=RELOJ-27

Imágenes

Imágenes de mejor calidad

Petición para obtener las imágenes

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/imagenes_alta?clave=PC-6150' \
     --header 'Authorization: Bearer TU_API_TOKEN'

json de respuesta

{
    "imagenes": [
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=341116",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=341118",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=341106",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=341110",
        "https://www.grupocva.com/detalle_articulo/img_large.php?id=341108"
    ]
}

También tienes la opción de obtener las imágenes en la misma búsqueda del producto (véase Imágenes). Sin embargo, si usted solo requiere las imágenes del producto, es mejor usar este endpoint ya que hace una consulta directa a la base de datos, mientras que la otra manera obtiene los datos de la memoria caché y puede que no esten actualizados.

Query parameters

Parametro	Tipo	Descripción	Valor por defecto
clave	string	Clave CVA del producto	false

Ejemplos con https Request

Obtener imágenes del producto con clave "PC-6150".

GET https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/imagenes_alta?clave=PC-6150

⚠️ No todos los productos tienen imágenes, por lo que algunos regresan el valor null.

Catálogos

Marcas

Catálogo de marcas

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/marcas'

json de respuesta

{
    "marcas": [
        {
            "marca": "ACER"
        },
        {
            "marca": "ACTECK"
        },
        {
            "marca": "ADATA"
        },
        {
            "marca": "ADESSO"
        },
        {
            "marca": "AMD"
        },
        -- entre otros --
    ]
}

En Grupo CVA, el catálogo de marcas incluye una amplia variedad de opciones en tecnología. Para consultarlas se hace usando el endpoint de marcas

Marcas con ID

Catálogo de marcas 2

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/marcas2'

json de respuesta

{
    "marcas": [
        {
            "clave": "3",
            "marca": "ACER"
        },
        {
            "clave": "4",
            "marca": "ACTECK"
        },
        {
            "clave": "123",
            "marca": "ADATA"
        },
        {
            "clave": "299",
            "marca": "ADESSO"
        },
        {
            "clave": "5",
            "marca": "AMD"
        },
        -- entre otros --
    ]
}

En Grupo CVA, el catálogo de marcas incluye una amplia variedad de opciones en tecnología. Para consultarlas se hace usando el endpoint de marcas

Grupos

Catálogo Grupos

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/grupos'

json de respuesta

{
    "grupos": [
        {
            "grupo": "ACCESO VIDEOCONFERENCIA"
        },
        {
            "grupo": "ACCESORIOS"
        },
        {
            "grupo": "AIRE ACONDICIONADO"
        },
        {
            "grupo": "ALARMAS"
        },
        {
            "grupo": "ALMACENAMIENTO"
        },
        {
            "grupo": "ANTENAS"
        },
        {
            "grupo": "ASPIRADORAS"
        },
        -- Entre otros --
    ]
}

Catálogo de los grupos de productos de CVA

Soluciones

Catálogo de soluciones

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/soluciones'

json de respuesta

{
    "soluciones": [
        {
            "clave": "1",
            "descripcion": "ALMACENAMIENTO"
        },
        {
            "clave": "2",
            "descripcion": "CABLEADO ESTRUCTURADO"
        },
        {
            "clave": "22",
            "descripcion": "CIBERSEGURIDAD"
        },
        {
            "clave": "3",
            "descripcion": "COMPONENTES ( OEM )"
        },
        {
            "clave": "4",
            "descripcion": "CÓMPUTO"
        },
        -- Entre otros --
    ]
}

Listado del catálogo de soluciones.

Ciudades

Obtener las ciudades

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/ciudades'

json de respuesta

{
    "estados": [
        {
            "estado": {
                "clave": "1",
                "descripcion": "AGUASCALIENTES",
                "ciudades": [
                    {
                        "clave": "1",
                        "descripcion": "AGUASCALIENTES"
                    },
                    {
                        "clave": "2",
                        "descripcion": "ASIENTOS"
                    },
                    {
                        "clave": "3",
                        "descripcion": "CALVILLO"
                    },
                    {
                        "clave": "4",
                        "descripcion": "COSIO"
                    },
                    {
                        "clave": "5",
                        "descripcion": "JESUS MARIA"
                    },
                    {
                        "clave": "6",
                        "descripcion": "EL LLANO"
                    },
                    {
                        "clave": "7",
                        "descripcion": "PABELLON DE ARTEAGA"
                    },
                    {
                        "clave": "8",
                        "descripcion": "RINCON DE ROMOS"
                    },
                    {
                        "clave": "9",
                        "descripcion": "SAN FRANCISCO DE LOS ROMO"
                    },
                    {
                        "clave": "10",
                        "descripcion": "SAN JOSE DE GRACIA"
                    },
                    {
                        "clave": "11",
                        "descripcion": "TEPEZALA"
                    }
                ]
            },
            -- otros --
        },
    ]
}

Obtiene los estados con las cuidades.

Sucursales

Obtener las ciudades

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/sucursales'

json de respuesta

{
    "sucursales": [
        {
            "clave": "1",
            "nombre": "GUADALAJARA",
            "cp": "44900"
        },
        {
            "clave": "3",
            "nombre": "MORELIA",
            "cp": "58000"
        },
        {
            "clave": "4",
            "nombre": "LEON",
            "cp": "37200"
        },
        {
            "clave": "5",
            "nombre": "CULIACAN",
            "cp": "80200"
        },
        {
            "clave": "6",
            "nombre": "QUERETARO",
            "cp": "76148"
        },
        -- entre otros --
    ]
}

Obtiene los catálogos de sucursales.

Paqueterías

Obtener las paqueterías

curl --location 'https://apicvaservices.grupocva.com/api/v2/catalogo_clientes/paqueteria'

json de respuesta

{
    "paqueterias": [
        {
            "clave": "86",
            "descripcion": "AOM GLOBAL EXPRESS"
        },
        {
            "clave": "10",
            "descripcion": "AUTOBUSES ESTRELLA BLANCA"
        },
        {
            "clave": "7",
            "descripcion": "DHL"
        },
        {
            "clave": "42",
            "descripcion": "DIPAQ"
        },
        -- entre otros --
    ]
}

Obtiene los catálogos de paqueterías.

Pedidos Web

En esta sección usted podrá consultar la información de sus pedidos.

Crear pedido

POST REQUEST EXAMPLE

curl --location 'https://apicvaservices.grupocva.com/api/v2/pedidos_web/crear_orden' \
--header 'Authorization: Bearer TU_API_TOKEN'
--header 'Content-Type: application/json'
--data '{
    "num_oc": "452069",
    "codigo_sucursal": 1,
    "observaciones": "Aqui van las observaciones que quiera darle a su pedido.",
    "tipo_flete": "FF",
    "flete": {
        "calle": "Circ. Jorge Álvarez del Castillo",
        "numero": "1517",
        "numero_interior": "C",
        "cp": "44610",
        "colonia": "Country Club",
        "estado": 15,
        "ciudad": 558,
        "paqueteria": 6,
        "atencion": "John Doe"
    },
    "productos": [
        {
            "clave": "NOTGHIA-286",
            "cantidad": 1
        }
    ]
}'

json de respuesta

{
    {
        "pedido": "NGB-XXXXXX",
        "total": 658.63,
        "email_agente": "agente@grupocva.com",
        "email_almacen": "almacen@grupocva.com"
    }
}

Utilice este endpoint para registrar un nuevo pedido en el sistema. A continuación, se detallan los pasos necesarios para realizar esta operación

Campo "num_oc"

El campo num_oc es un parámetro opcional que le permite asociar un número de orden de compra a su pedido. Este valor puede ser utilizado para fines de facturación, seguimiento o referencia interna.

Puede ser el número interno de su sistema o similar que le sirva a usted como referencia.

Parametro	Tipo	Descripción	Valor por defecto
num_oc	string	Número orden de compra	null

Campo "codigo_sucursal"

El parámetro codigo_sucursal le permite especificar la sucursal de CVA donde desea registrar su pedido. Este valor es esencial para asegurar que el pedido sea gestionado y atendido por la sucursal correcta.

Parametro	Tipo	Descripción	Valor por defecto
codigo_sucursal	int	Clave de la sucursal	null

Consulte: Catálogo de sucursales -> Obtén la clave de tu sucursal.

Campo "observaciones"

El parámetro observaciones le permite hacer observaciones que sean necesarias para su pedido.

Parametro	Tipo	Descripción	Valor por defecto
observaciones	string	Observaciones de su pedido	null

Campo "Flete"

✅ El campo flete, sólo será necesario cuando el tipo de flete sea diferente de 'SF'.

Parametro	Tipo	Descripción	Valor por defecto
calle	string	Nombre de la vialidad del flete	null
numero	string	Número de la vialidad del flete	null
numero_interior	string	Número interior de la vialidad del flete	null
cp	string	Código postal a donde se enviará el flete	null
colonia	string	Colonia del domicilio a donde se enviará el flete	null
estado	int	ID del estado a donde se enviará el flete	null
ciudad	int	ID de la ciudad a donde se enviará el flete	null
paquetería	int	ID de la paquetería que se requiera	null
atención	string	Nombre de la persona que le dará atención al flete	null

Significado de cada estado para los tipos de fletes

Sufijo	Significado
SF	Sin flete
FF	Flete cobrado en la factura de CVA
FS	Flete cobrado en la factura de CVA Asegurado

⚠️ Al realizar solicitudes que requieran flete, es fundamental que los IDs de estado y ciudad coincidan correctamente. Esto asegura que los datos sean procesados de manera precisa y sin errores.

Por ejemplo

Si desea especificar la ciudad de Guadalajara, cuyo ID es 558, debe asegurarse de que el estado correspondiente sea Jalisco, con ID 15. Una combinación incorrecta, como Guadalajara (558) con un estado distinto a Jalisco (15), resultará en un error.

Consulte: Catálogo de ciudades -> Obtén el ID de la ciudad y estado.

Consulte: Catálogo de paqueterías -> Obtén el ID de la paquetería.

Campo "productos"

El campo productos es un parámetro obligatorio y debe ser enviado como una lista (array). Este campo permite incluir uno o más productos en la solicitud, según sea necesario.

Parametro	Tipo	Descripción	Valor por defecto
clave	string	clave CVA del producto	null
cantidad	int	Cantidad de producto que se requiere	null

⚠️ La cantidad debe de ser mínimo de 1, de lo contrario no se podrá levantar el la orden.

Listado

Lista tus pedidos

curl --location 'https://apicvaservices.grupocva.com/api/v2/pedidos_web/lista_pedidos' \
     --header 'Authorization: Bearer TU_API_TOKEN'

Ejemplo de respuesta

{
    "pedidos": [
        {
            "Numero": "NGB-987217",
            "Total": 8770.69,
            "Moneda": "MN",
            "NumOC": null,
            "Almacen": "VENTAS GUADALAJARA",
            "Asignado": "INCOMPLETO",
            "FechaAsignado": "31/07/2024"
        },
        {
            "Numero": "NGB-675786",
            "Total": 19140,
            "Moneda": "USD",
            "NumOC": null,
            "Almacen": "GUADALAJARA CENTRO DE DISTRIBUCION",
            "Asignado": "INCOMPLETO",
            "FechaAsignado": null
        },
        {
            "Numero": "NGB-670741",
            "Total": 232,
            "Moneda": "USD",
            "NumOC": null,
            "Almacen": "VENTAS MONTERREY",
            "Asignado": "INCOMPLETO",
            "FechaAsignado": null
        },
        ...
    ],
    "status": "ok"
}

Para listar tus pedidos necesitas estar autenticado con un token, ya que el sistema lo necesita para saber qué usuario es el que está consultando y entregarle su lista de pedidos. Consulta (Autenticación) para saber como generar tu token.

En la parte derecha tiene un ejemplo de como hacer una petición con curl a este endpoint.

Asegúrate de cambiar TU_API_TOKEN por el token que te devolvió la consulta de autenticación.

Descripción

Obtiene una lista con la información de los pedidos generados por el usuario.

Pedido orden compra

Ver las ordenes de compra

curl --location 'https://apicvaservices.grupocva.com/api/v2/pedidos_web/pedido_orden_compra' \
--header 'Authorization: Bearer TU_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "orden": "ORDEN-001"
}'

Ejemplo de respuesta

{
    "orden": "ORDEN-001",
    "pedidos": [
        "G-324875",
        "G-337327",
        "G-340819",
        "G-373449",
        "G-396161",
        "G-403616",
    ],
    "status": "ok"
}

Para listar tus ordenes de compra necesitas estar autenticado con un token, ya que el sistema lo necesita para saber qué usuario es el que está consultando y entregarle su lista de pedidos. Consulta (Autenticación) para saber como generar tu token.

En la parte derecha tiene un ejemplo de como hacer una petición con curl a este endpoint.

Descripción

Devuelve una lista con las series de los pedidos asignados a la orden que se consulta.

Cuerpo de la petición (JSON)

Parametro	Tipo	Descripción
orden	string	numero de orden de compra (serie-folio)

Consultar información de facturas

Ver la información de las facturas

curl --location 'https://apicvaservices.grupocva.com/api/v2/pedidos_web/consultar_factura' \
--header 'Authorization: Bearer TU_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "factura": "GB-1111"
}'

Ejemplo de respuesta

{
    "factura": {
        "total": 768.94,
        "saldo": 0,
        "moneda": "MN",
        "fecha_factura": "10/12/2010",
        "num_oc": null,
        "almacen": "VENTAS GUADALAJARA",
        "observaciones": null,
        "calle_envio": null,
        "numero_envio": null,
        "numero_int_envio": null,
        "colonia_envio": null,
        "cp_envio": null,
        "estado_envio": null,
        "ciudad_envio": null,
        "atencion": null,
        "flete": "Sin Flete",
        "tipo_envio": null,
        "paqueteria": null,
        "guia": null,
        "productos": [
            {
                "clave": "KB-304",
                "fabricante": "920-001475",
                "cantidad": 1,
                "precio_sin_iva": 168.6927,
                "iva": 26.99
            },
            {
                "clave": "CN-779",
                "fabricante": "CLT-K409S/XAX",
                "cantidad": 1,
                "precio_sin_iva": 494.1859,
                "iva": 79.07
            }
        ]
    },
    "status": "ok"
}

Para listar la información de facturas necesitas estar autenticado con un token, ya que el sistema lo necesita para saber qué usuario es el que está consultando y entregarle su lista de pedidos. Consulta (Autenticación) para saber como generar tu token.

En la parte derecha tiene un ejemplo de como hacer una petición con curl a este endpoint.

Descripción

Devuelve los datos de la factura, así como los productos que vienen en la misma.

El web service recibe un JSON con el código de la factura. ejemplo (GB-111).

En el ejemplo de respuesta se puede ver como es la estructura que regresa el endpoint.

Parámetros de la peticion (JSON)

Parametro	Tipo	Descripción
factura	string	numero de factura (serie-folio)

Consultar pedido

GET REQUEST EXAMPLE

curl --location 'https://apicvaservices.grupocva.com/api/v2/pedidos_web/consultar_pedido' \
--header 'Authorization: Bearer TU_API_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
    "pedido": "G-337327"
}'

Ejemplo de respuesta

{
    "pedido": {
        "estatus": "FACTURADO",
        "factura": "G-228920",
        "total": 155.25,
        "moneda": "MN",
        "fecha_pedido": "22/06/2009",
        "num_oc": "ROBERTO",
        "almacen": "VENTAS GUADALAJARA",
        "observaciones": "RECOGEN    ",
        "calle_envio": null,
        "numero_envio": null,
        "ciudad_envio": null,
        "atencion": null,
        "flete": null,
        "tipo_envio": null,
        "paqueteria": null,
        "guia": null,
        "productos": [
            {
                "clave": "RAM-1042",
                "fabricante": "SDSDB-004G-B35",
                "cantidad": 1,
                "precio_sin_iva": 135,
                "iva": 21.6
            }
        ]
    },
    "status": "ok"
}

Para consultar la información de tu pedido necesitas estar autenticado con un token, ya que el sistema lo necesita para saber qué usuario es el que está consultando y entregarle su lista de pedidos. Consulta (Autenticación) para saber como generar tu token.

En la parte derecha tiene un ejemplo de como hacer una petición con curl a este endpoint.

Devuelve la información de un pedido

Significado de los status

Valor	Descripción
PENDIENTE	Pedido pendiente de faturar
CANCELADO	Pedido cancelado
FACTURADO	Pedido ya facturado

Parámetros de la peticion (JSON)

Parametro	Tipo	Descripción
factura	string	numero de pedido (serie-folio)

Guías de envío

Para consultar la documentación sobre las guías de envío, por favor acceda al siguiente enlace:

Documentación: GUíAS DE ENVíO

Errores

Esta API los siguientes codigos de error:

Código de error	Significado
400	Bad Request -- La petición no es correcta.
403	Forbidden -- No tienes permiso para acceder al contenido.
503	Service Unavailable -- Servidor fuera de servicio o en mantenimiento.