Skip to main content

Leer artículos

Con esta función, se tiene la capacidad de leer los componentes que han sido registrados en el sistema. Es importante destacar que se puede proporcionar el código del artículo que se desea leer a través de un argumento de URL query. En caso de no especificar este código, se llevará a cabo la lectura de todos los componentes del sistema.

URL

/CTNEAT/ITEM/READ/{tkn}

Método HTTP

GET

Parámetros de la solicitud

Nombre del parámetro Tipo de dato Descripción del parámetro Obligatorio Posibles valores
ITEMCODE cadena Código interno del artículo No (Si el código de artículo no se especifica, la API devolverá todos los artículos del sistema) Cualquiera

Encabezados de la solicitud

Nombre del encabezado Descripción del encabezado Obligatorio

Cuerpo de la solicitud

No se requiere un cuerpo de solicitud para este método HTTP.

Parámetros de la respuesta

Nombre del parámetro Tipo de dato Descripción del parámetro
Result JSON Json con la descripción del resultado de la operación
Elementos de Result
  • Result.NRecords: Valor numérico que indica el número de registros en la matriz Result.Data.
  • Result.Data: Matriz que contiene uno o más objetos (Cantidad de registrios leídos).
  • Result.Data[x].ItemCode: Representa el código del ítem.
  • Result.Data[x].Type: Representa el tipo del ítem.
  • Result.Data[x].Format: Representa el formato del ítem.
  • Result.Data[x].QTY: Representa la cantidad existente del ítem.
  • Result.Data[x].ActCont: Representa el número de contenedores activos del ítem.

Códigos de estado de la respuesta

Código de estado Descripción del código de estado Posibles razones
200 OK La solicitud fue exitosa
400 Petición errónea Alguno de los parámetros pasados no es correcto
500 Error interno Error en el servidor
401 Unauthorized El usuario no está autenticado

Ejemplo de consulta

http://ctincoming/ITEM/READ/693DDFEC2F4BFDDEAF04DD2724984C9B3CA89D553DD8E5B9BB233AD6BB6075F1?ITEMCODE=CODIGO_PN

Ejemplo de respuesta

{ 
  "NRecords":1, 
  "Data":[ 
    { 
      "ItemCode":"CODIGO_PN", 
      "Description":"MODIF_DESCRIPCION_CODIGO_PN", 
      "Type":"REEL", 
      "Format":"H08S", 
      "QTY":0, 
      "ActCont":0 
    } 
  ] 
}
Back to top