Article Categories

Nombre

Tipo y longitud o rango de dato

Descripción

Requerido

Default

HOST

URL

Se indicará de acuerdo el ambiente

donde será consumido el servicio:

Producción:

https://api.next-cloud.mx

Staging:

https://stg-api.next-cloud.mx

Sí

N/A

GET Secciones

Obtiene las secciones a las que puede pertenecer un artículo.

Resource URL

GET HOST/v1/catalogs/sections/

Encabezados de solicitud:

Authorization – Token del usuario

Parámetros de consulta:

status (string) – Estatus del registro 1 = Activo 0 = Inactivo.

Códigos de Status:

200 OK – Ningún error.
400 Bad Request – Algún parámetro es incorrecto.
401 Unauthorized – Token no válido o no enviado.
500 Internal Server Error – Error interno.

Arreglo de secciones

Objeto JSON de respuesta:

id (int) – ID de la sección.
description (string) – Descripción de la sección.
status (string) – Estatus del registro 1 Activo 0 Inactivo.

Ejemplo de petición

GET HOST/v1/catalogs/sections/ HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token ( token del usuario )

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS

[
    {
        "id": 0,
        "description": "-- Seleccione una opción--",
        "status": "1"
    },
    {
        "id": 1,
        "description": "ROPA",
        "status": "0"
    },
    {
        "id": 2,
        "description": "PLOMERÍA",
        "status": "1"
    },
    {
        "id": 3,
        "description": "VÁLVULAS, CONEXIONES Y TUBERÍA",
        "status": "0"
    },
    {
        "id": 4,
        "description": "MISCELÁNEOS",
        "status": "1"
    },
    {
        "id": 5,
        "description": "EQUIPO Y MATERIAL DE SOLDADURA",
        "status": "1"
    },
    {
        "id": 6,
        "description": "IZAJE Y CARGA",
        "status": "0"
    }
]

Ejemplo de petición (estado = 1)

GET HOST/v1/catalogs/sections/?status=1 HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token (token del usuario)

Ejemplo de respuesta

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS

[
    {
        "id": 0,
        "description": "-- Seleccione una opción--",
        "status": "1"
    },
    {
        "id": 2,
        "description": "PLOMERÍA",
        "status": "1"
    },
    {
        "id": 4,
        "description": "MISCELÁNEOS",
        "status": "1"
    },
    {
        "id": 5,
        "description": "EQUIPO Y MATERIAL DE SOLDADURA",
        "status": "1"
    }
]

GET Categorias

Obtiene las categorias a las que puede pertenecer un artículo.

Resource URL

GET HOST/v1/catalogs/categories/

Encabezados de solicitud:

Authorization – Token del usuario

Parámetros de consulta:

section (string) – Identificador unico de la sección.
status (string) – Estatus del registro 1 = Activo 0 = Inactivo.

Códigos de Status:

200 OK – Ningún error.
400 Bad Request – Algún parámetro es incorrecto.
401 Unauthorized – Token no válido o no enviado.
500 Internal Server Error – Error interno.

Arreglo de categorias

Objeto JSON de respuesta:

id (int) – ID de la categoría.
description (string) – Descripción de la categoría.
section (int) – ID de la sección a la que pertenece.
status (string) – Estatus del registro 1 Activo 0 Inactivo.

Ejemplo de petición

GET HOST/v1/catalogs/categories/ HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token ( token del usuario )

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS

[
    {
        "id": 0,
        "description": "-- Seleccione --",
        "section": 0,
        "status": "1"
    },
    {
        "id": 297,
        "description": "Fibra Óptica",
        "section": 0,
        "status": "1"
    },
    {
        "id": 298,
        "description": "HVAC",
        "section": 0,
        "status": "0"
    },
    {
        "id": 455,
        "description": "Woks",
        "section": 0,
        "status": "1"
    },
    {
        "id": 458,
        "description": "Ciencia ficción",
        "section": 0,
        "status": "0"
    },
    {
        "id": 1,
        "description": "ROPA DAMA",
        "section": 1,
        "status": "1"
    },
    {
        "id": 3,
        "description": "ROPA CABALLERO",
        "section": 1,
        "status": "1"
    },
    {
        "id": 7,
        "description": "FERRETERÍA",
        "section": 2,
        "status": "1"
    },
    {
        "id": 8,
        "description": "MAQUINARIA Y EQUIPO",
        "section": 2,
        "status": "0"
    }
]

Ejemplo de petición (estado = 1, sección = 5)

GET HOST/v1/catalogs/categories/?status=1&section=5 HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token (token del usuario)

Ejemplo de respuesta

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS

[
    {
        "id": 6,
        "description": "FERRETERÍA",
        "section": 5,
        "status": "1"
    },
    {
        "id": 12,
        "description": "MAQUINARIA Y EQUIPO",
        "section": 5,
        "status": "1"
    },
    {
        "id": 14,
        "description": "MATERIAL ELECTRICO",
        "section": 5,
        "status": "1"
    }
]

GET Lineas

Obtiene las lineas a las que puede pertenecer un artículo.

Resource URL

GET HOST/v1/catalogs/lines/

Encabezados de solicitud:

Authorization – Token del usuario

Parámetros de consulta:

category (string) – Identificador unico de la categoría.
status (string) – Estatus del registro 1 = Activo 0 = Inactivo.

Códigos de Status:

200 OK – Ningún error.
400 Bad Request – Algún parámetro es incorrecto.
401 Unauthorized – Token no válido o no enviado.
500 Internal Server Error – Error interno.

Arreglo de lineas

Objeto JSON de respuesta:

id (int) – ID de la línea.
description (string) – Descripción de la línea.
category (int) – ID de la categoría a la que pertenece.
status (string) – Estatus del registro 1 Activo 0 Inactivo.

Ejemplo de petición

GET HOST/v1/catalogs/lines/ HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token ( token del usuario )

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS

[
    {
        "id": 0,
        "description": "Inicial",
        "category": 0,
        "status": "0"
    },
    {
        "id": 313,
        "description": "Cable",
        "category": 0,
        "status": "1"
    },
    {
        "id": 314,
        "description": "Herrajes",
        "category": 0,
        "status": "1"
    },
    {
        "id": 1,
        "description": "Compartir",
        "category": 1,
        "status": "1"
    },
    {
        "id": 70,
        "description": "BASICOS",
        "category": 1,
        "status": "0"
    }
]

Ejemplo de petición (estado = 1, categoría = 3)

GET HOST/v1/catalogs/lines/?status=1&category=3 HTTP/1.1
Host: api.next-cloud.mx
Accept: application/json
Authorization: Token (token del usuario)

Ejemplo de respuesta

HTTP/1.1 200 OK
Vary: Accept
Content-Type: application/json
Allow: GET, OPTIONS

[
    {
        "id": 3,
        "description": "NO APLICA",
        "category": 3,
        "status": "1"
    },
    {
        "id": 236,
        "description": "SANDALIAS",
        "category": 3,
        "status": "1"
    }
]