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

De API LaFactura.co
Ir a la navegación Ir a la búsqueda
 
(No se muestran 24 ediciones intermedias del mismo usuario)
Línea 1: Línea 1:
 
==UNSPSC==
 
==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'''
 
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'''
 +
 +
<br/><b>Importante:</b> Ninguno de los servicios vinculados a UNPSPSC están disponibles en el API v3.0
  
 
==== Segmentos ====
 
==== Segmentos ====
 
-----
 
-----
−
Método Segmentos: Devulve el conjunto completo de segmentos del standard
+
Método Segmentos: Devulve el conjunto completo de segmentos del standard (No disponibe en API v3.0)
  
 
   {
 
   {
Línea 37: Línea 39:
 
             },
 
             },
 
             "data":[
 
             "data":[
−
               {
+
               {"code":"10000000","es":"Material Vivo Vegetal y Animal, Accesorios y Suministros"},
−
                "code":"10000000",
+
               {"code":"11000000","es":"Material Mineral, Textil y Vegetal y Animal No Comestible"},
−
                "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"}
−
                "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 ====
 
==== Familias ====
 
-----
 
-----
−
Método Familias: Devuelve todas las familias pertenecientes a un segmento
+
Método Familias: Devuelve todas las familias pertenecientes a un segmento (No disponibe en API v3.0)
  
 
   {
 
   {
Línea 94: Línea 90:
 
         },
 
         },
 
         "data":[
 
         "data":[
−
             {
+
             {"code":"10100000","es":"Animales vivos"},
−
              "code":"10100000",
+
             {"code":"10110000","es":"Productos para animales domésticos"},
−
              "es":"Animales vivos"
+
             {"code":"10120000","es":"Comida de animales"},
−
            },
 
−
             {
 
−
              "code":"10110000",
 
−
              "es":"Productos para animales domésticos"
 
−
            },
 
−
             {
 
−
              "code":"10120000",
 
−
              "es":"Comida de animales"
 
−
            },
 
 
             .
 
             .
 
             .
 
             .
 
             .
 
             .
−
             {
+
             {"code":"10500000","es":"Follaje cortado fresco"}
−
              "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 ====
 
==== Clases ====
 
-----
 
-----
−
Método Clases: Devuelve todas las clases pertenecientes a una familia
+
Método Clases: Devuelve todas las clases pertenecientes a una familia (No disponibe en API v3.0)
  
 
   {
 
   {
Línea 144: Línea 132:
 
| family || Familia del cual se desean todas las clases (4 dígitos) || 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"}
 +
            ]
 +
        }
 +
    }
 +
 +
===== 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.
  
 
==== Productos ====
 
==== Productos ====
 
-----
 
-----
−
Método Productos: Devuelve todos los productos pertenecientes a una clase
+
Método Productos: Devuelve todos los productos pertenecientes a una clase (No disponibe en API v3.0)
  
 
   {
 
   {
Línea 173: Línea 184:
 
| class || clase del cual se desean obtener los productos (6 dígitos) || 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"}
 +
              ]
 +
        }
 +
    }
 +
 +
===== 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.
  
 
==== Producto por código ====
 
==== Producto por código ====
 
-----
 
-----
−
Método por código: Devuelve toda la información referente a un código UNSPSC.
+
Método por código: Devuelve toda la información referente a un código UNSPSC. (No disponibe en API v3.0)
  
 
   {
 
   {
Línea 202: Línea 233:
 
| code || Código del producto (8 dígitos) || 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"}
 +
                ]
 +
            }
 +
      }
 +
 +
===== A Tener presente =====
 +
Este resultado presenta varios objetos, el primero es el mensaje de error o estado del proceso (status), los otros:
 +
 +
<b>code:</b> Información relacionada con el código (arreglo)<br/>
 +
<b>class:</b> Información de la clase a la que corresponde (arreglo)<br/>
 +
<b>family:</b> Información de la familia a la que corresponde (arreglo)<br/>
 +
<b>segment:</b> Segmento al cual pertenece (arreglo)<br/>
  
 
==== Producto por texto ====
 
==== 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.
+
Método de búsqueda por texto: Devuelve todos los códigos que en su texto contengan el "texto", entre un segmento dado. (No disponibe en API v3.0)
  
 
   {
 
   {
Línea 236: Línea 298:
  
 
=====Resultados=====
 
=====Resultados=====
−
Devuelve un objeto '''[[API_laFactura.co:generalResult|generalResult]]''' con el resultado de la operación y la información referente a los rangos
+
 
−
 
+
    {
−
    {
+
        "generalResult":{
−
          "generalResult":{
+
            "status":{
−
              "status":{
+
                  "code":200,
−
                "code":200,
+
                  "text":"Operación realizada con exito"
−
                "text":"Operación realizada con exito"
+
            },
−
              },
+
            "data":[
−
              "ranges":[
+
                {"code":"10151504","es":"Semillas o plántulas de chiles"},
−
                  {
+
                {"code":"10216001","es":"Pimiento chile vivo ornamental"},
−
                    "rangeKey":"rk-c1cbededb62c3546c19ad0676cca4cb85",
+
                {"code":"10316001","es":"Pimiento chile cortado fresco ornamental"},
−
                    "type":"invoice",
+
                {"code":"10416001","es":"Pimiento chile cortado seco ornamental"}
−
                    "prefix":"SETP",
 
−
                    "from":"990000000",
 
−
                    "to":"995000000",
 
−
                    "last":"990000102"
 
−
                  },
 
−
                  {
 
−
                    "rangeKey":"rk-009e51a3986e10aad892275fb1e72594a",
 
−
                    "type":"creditNote",
 
−
                    "prefix":"NCR",
 
−
                    "from":"0",
 
−
                    "to":"999999999",
 
−
                    "last":"17"
 
−
                  },
 
−
                  {
 
−
                    "rangeKey":"rk-ad664ee282763d4f89870b653ac5b90e8",
 
−
                    "type":"debitNote",
 
−
                    "prefix":"NDE",
 
−
                    "from":"0",
 
−
                    "to":"999999999",
 
−
                    "last":"11"
 
−
                  }
 
 
               ]
 
               ]
−
          }
+
        }
−
      }
+
    }
  
−
=====ranges=====
+
===== A Tener presente =====
−
Información referente a los rangos solicitados (Es un arreglo):
+
Este resultado presenta dos objetos, el primero es el mensaje de error o estado del proceso (status), el otro (data), contiene todos los registros que cumplieron con la búsqueda.
−
 
 
−
{| class="wikitable"
 
−
|-
 
−
! Parámetro !! Descripción !! Tipo !! Obligatorio
 
−
|-
 
−
| rangeKey || Llave del rango<br><small>Es requerido para enviar una factura</small> || cadena || SI
 
−
|-
 
−
| type || Tipo de rango<br><small>invoice -> Factura<br>debitNote -> Nota Debito<br>creditNote -> Nota Credito</small> || 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==
 
==Objetos Empleados==

Revisión actual del 16:08 20 abr 2021

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


Importante: Ninguno de los servicios vinculados a UNPSPSC están disponibles en el API v3.0

Segmentos

Método Segmentos: Devulve el conjunto completo de segmentos del standard (No disponibe en API v3.0) 

 {
      "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 (No disponibe en API v3.0) 

 {
      "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 (No disponibe en API v3.0) 

 {
      "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"}
           ]
       }
   }
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.

Productos

Método Productos: Devuelve todos los productos pertenecientes a una clase (No disponibe en API v3.0) 

 {
      "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"}
             ]
        }
   }
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.

Producto por código

Método por código: Devuelve toda la información referente a un código UNSPSC. (No disponibe en API v3.0) 

 {
      "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"}
                ]
           }
      }
A Tener presente

Este resultado presenta varios objetos, el primero es el mensaje de error o estado del proceso (status), los otros:

code: Información relacionada con el código (arreglo)
class: Información de la clase a la que corresponde (arreglo)
family: Información de la familia a la que corresponde (arreglo)
segment: Segmento al cual pertenece (arreglo)

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. (No disponibe en API v3.0) 

 {
      "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"}
             ]
        }
    }
A Tener presente

Este resultado presenta dos objetos, el primero es el mensaje de error o estado del proceso (status), el otro (data), contiene todos los registros que cumplieron con la búsqueda.

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=1473»