Diferencia entre revisiones de «API LaFactura.co:UNSPSC»

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
Línea 118: Línea 118:
 
         ]
 
         ]
 
     }
 
     }
 +
 +
===== A Tener presente =====
 +
Este resultado presenta dos objetos, el primero es el mensaje de error o estado del proceso (status), y el segundo (data), trae un arreglo con los campos solicitados de la base de datos.
  
 
==== Clases ====
 
==== Clases ====

Revisión del 21:03 27 jul 2020

UNSPSC

Es el estándard internacional de clasificación de productos creado por las Nacciones Unidas y utilizado por gran cantidad de países entre los que se encuentra Colombia. Este servicio consta de varios tipos de consulta por el método GET

Segmentos

Método Segmentos: Devulve el conjunto completo de segmentos del standard 

 {
      "UNSPSC":{
           "version":"v14.0.80",
           "getSegments": {
                  "lang":"es"
            }
      }
 }
Objeto
Parámetro Descripción Tipo Obligatorio
version Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 cadena SI
getSegments Objeto para obtener segmentos objeto SI
lang Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) cadena SI
Resultados
  {
       "generalResult":{
           "status":{
              "code":200,
              "text":"Operación realizada con exito"
           },
           "data":[
              {
                "code":"10000000",
                "es":"Material Vivo Vegetal y Animal, Accesorios y Suministros"
              },
              {
                "code":"11000000",
                "es":"Material Mineral, Textil y Vegetal y Animal No Comestible"
              },
              .
              .
              .
              {
                "code":"95000000",
                "es":"Terrenos, Edificios, Estructuras y Vías"
              }
           ]
        }
  }
A Tener presente

Este resultado presenta dos objetos, el primero es el mensaje de error o estado del proceso (status), y el segundo (data), trae un arreglo con los campos solicitados de la base de datos.

Familias

Método Familias: Devuelve todas las familias pertenecientes a un segmento 

 {
      "UNSPSC":{
           "version":"v14.0.80",
           "getFamilies": {
                  "lang":"es",
                  "segment":"10"
            }
      }
 }
Objeto
Parámetro Descripción Tipo Obligatorio
version Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 cadena SI
getFamilies Objeto para obtener familias objeto SI
lang Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) cadena SI
segment Segmento del cual se desean las familias (2 dígitos) cadena SI
Resultados
  {
       "generalResult":{
            "status":{
              "code":200,
              "text":"Operación realizada con exito"
        },
        "data":[
           {
              "code":"10100000",
              "es":"Animales vivos"
           },
           {
              "code":"10110000",
              "es":"Productos para animales domésticos"
           },
           {
              "code":"10120000",
              "es":"Comida de animales"
           },
           .
           .
           .
           {
              "code":"10500000",
              "es":"Follaje cortado fresco"
           }
        ]
    }
A Tener presente

Este resultado presenta dos objetos, el primero es el mensaje de error o estado del proceso (status), y el segundo (data), trae un arreglo con los campos solicitados de la base de datos.

Clases

Método Clases: Devuelve todas las clases pertenecientes a una familia 

 {
      "UNSPSC":{
           "version":"v14.0.80",
           "getClasses": {
                  "lang":"es",
                  "family":"1050"
            }
      }
 }
Objeto
Parámetro Descripción Tipo Obligatorio
version Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 cadena SI
getClasses Objeto para obtener clases objeto SI
lang Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) cadena SI
family Familia del cual se desean todas las clases (4 dígitos) cadena SI
Resultados
  {
       "generalResult":{
           "status":{
              "code":200,
              "text":"Operación realizada con exito"
           },
           "data":[
              {
                 "code":"10501500",
                 "es":"Aspidistras cortadas frescas"
              },
              {
                 "code":"10501600",
                 "es":"Chili verde cortado fresco"
              },
              {
                 "code":"10501700",
                 "es":"Haya cortada fresca"
              },
              .
              .
              .
              {
                 "code":"10502900",
                 "es":"Hojas frescas cortadas de especies sencillas"
              }
           ]
       }
    }

Productos

Método Productos: Devuelve todos los productos pertenecientes a una clase 

 {
      "UNSPSC":{
           "version":"v14.0.80",
           "getProducts": {
                  "lang":"es",
                  "class":"105016"
            }
      }
 }
Objeto
Parámetro Descripción Tipo Obligatorio
version Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 cadena SI
getProducts Objeto para obtener productos objeto SI
lang Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) cadena SI
class clase del cual se desean obtener los productos (6 dígitos) cadena SI
Resultados
   {
       "generalResult":{
            "status":{
                 "code":200,
                 "text":"Operación realizada con exito"
            },
            "data":[
                {
                   "code":"10501601",
                   "es":"Chili verde cortado fresco avellana"
                },
                {
                   "code":"10501602",
                   "es":"Chili verde cortado fresco romerillo"
                },
                {
                   "code":"10501603",
                   "es":"Chili verde cortado fresco pacarilla"
                },
                {
                   "code":"10501604",
                   "es":"Chili verde cortado fresco musgo"
                }
             ]
        }
   }

Producto por código

Método por código: Devuelve toda la información referente a un código UNSPSC. 

 {
      "UNSPSC":{
           "version":"v14.0.80",
           "getProductByCode": {
                  "lang":"es",
                  "code":"10501601"
            }
      }
 }
Objeto
Parámetro Descripción Tipo Obligatorio
version Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 cadena SI
getProductByCode Objeto para obtener información de un producto objeto SI
lang Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) cadena SI
code Código del producto (8 dígitos) cadena SI
Resultado
  {
        "generalResult":{
                "status":{
                    "code":200,
                    "text":"Operación realizada con exito"
                },
                "code":[
                   {
                      "code":"10501601",
                      "es":"Chili verde cortado fresco avellana"
                   }
                ],
                "class":[
                   {
                      "code":"10501600",
                      "es":"Chili verde cortado fresco"
                   }
                ],
                "family":[
                   {
                      "code":"10500000",
                      "es":"Follaje cortado fresco"
                   }
                ],
                "segment":[
                   {
                      "code":"10000000",
                      "es":"Material Vivo Vegetal y Animal, Accesorios y Suministros"
                    }
                ]
           }
      }

Producto por texto

Método de búsqueda por texto: Devuelve todos los códigos que en su texto contengan el "texto", entre un segmento dado. 

 {
      "UNSPSC":{
           "version":"v14.0.80",
           "getProductByText": {
                  "lang":"es",
                  "segment":"10",
                  "text":"chile"
            }
      }
 }
Objeto
Parámetro Descripción Tipo Obligatorio
version Versión de UNSPSC a ser utilizada .. debe contener: v14.0.80 cadena SI
getProductByText Busca productos por texto objeto SI
lang Idioma de la respuesta (en->Inglés, es->Español, all->Todos los idiomas disponibles) cadena SI
segment Segmento en el que se desea buscar (2 dígitos) cadena SI
text Texto que se desea buscar cadena SI
Resultados
   {
        "generalResult":{
            "status":{
                 "code":200,
                 "text":"Operación realizada con exito"
            },
            "data":[
               {"code":"10151504","es":"Semillas o plántulas de chiles"},
               {"code":"10216001","es":"Pimiento chile vivo ornamental"},
               {"code":"10316001","es":"Pimiento chile cortado fresco ornamental"},
               {"code":"10416001","es":"Pimiento chile cortado seco ornamental"}
             ]
        }
    }
ranges

Información referente a los rangos solicitados (Es un arreglo):

Parámetro Descripción Tipo Obligatorio
rangeKey Llave del rango
Es requerido para enviar una factura		 cadena SI
type Tipo de rango
invoice -> Factura
debitNote -> Nota Debito
creditNote -> Nota Credito		 cadena SI
prefix Prefijo de facturacion cadena SI
from Primer numero del rango cadena SI
to Ultimo numero del rango cadena SI
last Ultimo numero usado cadena SI
A tener presente
  • rangeKey es la llave requerida para enviar solicitud de una factura al sistema
  • Si se solicitan los rangos activos, solamente aparecerá un rango por cada tipo de documento generable

Objetos Empleados

Temas complementarios

Enlaces

Importante

Recuerda que nosotros no te cobramos absolutamente nada por que pruebes nuestra plataforma.
Si deseas tener un usuario y contraseña , comunícate con nosotros.

Obtenido de «https://wiki.lafactura.co/index.php?title=API_LaFactura.co:UNSPSC&oldid=644»