Consultar Masivo
Este método consulta el estado de uno o varios documentos.
Valores
| Variable | Descripción | Prod | Demo |
|---|---|---|---|
URL_API | URL base de la API | https://api.emite.pe | https://api.demo.emite.pe |
EMITE_ID | Identificador asignado a la empresa | Proporcionado por Emite | Proporcionado por Emite |
EMITE_KEY | API Key asignada a la empresa | Proporcionado por Emite | Proporcionado por Emite |
Request
POST {{URL_API}}/guia-remision-transportista/consultar-masivo
Headers
emite_id: {{EMITE_ID}}
emite_key: {{EMITE_KEY}}
Content-Type: application/json
Estructura Body
El arreglo documentos contiene los documentos que serán consultados.
{
"documentos": [
{...},
{...}
]
}
La estructura completa del body se detalla en la tabla Propiedades Body.
Implementación
- Shell
- Node
- Java
- PHP
curl "{{URL_API}}/guia-remision-transportista/consultar-masivo" -X POST \
-H "emite_id: {{EMITE_ID}}" \
-H "emite_key: {{EMITE_KEY}}" \
-H "Content-Type: application/json" \
-d "{\"documentos\":[{...},{...}]}"
const axios = require('axios');
const data = {
documentos: [
{
// ...
},
{
// ...
}
]
};
axios.post('{{URL_API}}/guia-remision-transportista/consultar-masivo', data, {
headers: {
emite_id: '{{EMITE_ID}}',
emite_key: '{{EMITE_KEY}}',
'Content-Type': 'application/json'
}
})
.then(response => {
console.log(response.data);
})
.catch(error => {
console.error(error.response?.data || error.message);
});
import java.io.OutputStream;
import java.net.HttpURLConnection;
import java.net.URL;
public class Main {
public static void main(String[] args) throws Exception {
URL url = new URL("{{URL_API}}/guia-remision-transportista/consultar-masivo");
HttpURLConnection conn = (HttpURLConnection) url.openConnection();
conn.setRequestMethod("POST");
conn.setRequestProperty("emite_id", "{{EMITE_ID}}");
conn.setRequestProperty("emite_key", "{{EMITE_KEY}}");
conn.setRequestProperty("Content-Type", "application/json");
conn.setDoOutput(true);
String json = """
{
"documentos": [
{
}
]
}
""";
try (OutputStream os = conn.getOutputStream()) {
byte[] input = json.getBytes("utf-8");
os.write(input, 0, input.length);
}
int statusCode = conn.getResponseCode();
System.out.println("HTTP Status: " + statusCode);
}
}
<?php
$data = (object)[
'documentos' => [
(object)[
// ...
]
]
];
$ch = curl_init('{{URL_API}}/guia-remision-transportista/consultar-masivo');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'emite_id: {{EMITE_ID}}',
'emite_key: {{EMITE_KEY}}',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
if (curl_errno($ch)) {
echo 'Error: ' . curl_error($ch);
} else {
echo $response;
}
curl_close($ch);
Propiedades Body
| Propiedad | Obligatoriedad | Tipo | Descripción |
|---|---|---|---|
| documentos | Requerido | array[object] | Contiene el listado de documentos a consultar. |
| documentos[i]. serie | Requerido | string Tamaño: [4] | Contiene la serie del documento. |
| documentos[i]. correlativo | Requerido | integer Tamaño: [1...8] | Contiene el correlativo del documento. |
Response
Si el código de estado es 200 la petición anterior retorna un JSON estructurado de la siguiente manera:
Success
200 — Cuando el proceso se ejecute correctamente.
{
"ticketPeticion": "1537486212351-1024216",
"documentos": [
{
"serie": "V001",
"correlativo": 1,
"estado": 3,
"nombreEstado": "ACEPTADO",
"estadoSunat": "0",
"observaciones": [
"El Comprobante número V001-1, ha sido aceptado"
],
"ticketSunat": "2adf322f-...-ba7b96ebfb0a",
"estaAnulado": false
}
]
}
| Propiedad | Condición | Tipo | Descripción |
|---|---|---|---|
| ticketPeticion | Siempre | string | Código identificador de la petición. |
| documentos | Siempre | array[object] | Contiene el listado de documentos declarados. |
| documentos[i]. serie | Siempre | string | Contiene la serie del documento. |
| documentos[i]. correlativo | Siempre | integer Tamaño: [1...8] | Contiene el correlativo del documento. |
| documentos[i]. estado | Siempre | integer | Código interno de estado del documento. |
| documentos[i]. nombreEstado | Siempre | string | Descripción de estado interno del documento. |
| documentos[i]. estadoSunat | Siempre | string | Código de validación SUNAT. |
| documentos[i]. observaciones | Siempre | array[string] | Lista de mensajes asociados a la operación. |
| documentos[i]. ticketSunat | Siempre | string | Número de ticket de la operación de registro en SUNAT. |
| documentos[i]. estaAnulado | Siempre | boolean | Indica si el documento fue comunicado de baja (en el caso de guías siempre será false). |
Si el código de estado es 400, 401, 402, 403, 404 o 500 la petición anterior retorna un JSON estructurado de la siguiente manera:
Bad Request
400 - ERROR DE ESTRUCTURA JSON O EN LOS PARÁMETROS ENVIADOS.
Unauthorized
401 - ERROR DE AUTORIZACIÓN.
Payment Required
402 - ERROR POR FALTA DE PAGO.
Forbidden
403 - ERROR POR VALIDACIONES.
Not Found
404 - RECURSO NO ENCONTRADO.
Internal Server Error
500 - ERROR EN EL SERVIDOR.
{
"ticketPeticion": "1537486212351-1024216",
"estado": "NOT_FOUND",
"mensaje": "El Comprobante número << V001-1 >> no ha sido registrado"
}
| Propiedad | Condición | Tipo | Descripción |
|---|---|---|---|
| ticketPeticion | Siempre | string | Código identificador de la petición. |
| estado | Siempre | string | Nombre del estado HTTP retornado:BAD_REQUESTUNAUTHORIZEDPAYMENT_REQUIREDFORBIDDENNOT_FOUNDINTERNAL_SERVER_ERROR. |
| mensaje | Siempre | string | Descripción del resultado o error retornado por la API. |