v1.28 ›

Pedidos — Consultar

Frecuencia de actualización recomendada: 15 minutos

Con este endpoint se pueden obtener los pedidos sin procesar (estado: 0) de forma paginada mediante el parámetro batchSize. Es posible filtrar por otros parámetros en simultáneo.

GET/v1/pedidos
Parameters
ParámetroTipoDescripción
fechaDesdeStringFiltro para obtener los pedidos a partir de una fecha. Formato: "yyyy-MM-dd HH:mm:ss.fff". Ejemplos: "2024-10-20", "2024-10-20 04:27:30", "2024-11-20T10:54:22".
fechaHastaStringFiltro para obtener los pedidos hasta una fecha. Mismo formato.
fechaSubidaDesdeStringFiltro para obtener los pedidos a partir de una fecha de subida. Mismo formato.
fechaSubidaHastaStringFiltro para obtener los pedidos hasta una fecha de subida. Mismo formato.
batchSizeIntCantidad de pedidos a solicitar (máximo 5000).
idDesdeIntFiltro para obtener los pedidos con id igual o mayor al enviado.
vendedorStringFiltro para obtener los pedidos del vendedor enviado.
estadoIntFiltro para obtener los pedidos con un estado específico. 0: Nuevo | 1: Procesado.
Response body
CampoTipoDescripción
idLongRequiredCódigo identificador del ítem del pedido.
guidString(64)RequiredCódigo que sirve para asociar a un conjunto de ítems dentro de un pedido único.
estadoString(1)RequiredEstado en el que se encuentra el pedido. 0: Nuevo | 1: Procesado.
clienteIdString(64)RequiredCliente asociado al pedido.
vendedorIdString(20)RequiredVendedor asociado al pedido.
fechaPedidoDatetimeRequiredFecha en la que se realizó el pedido.
fechaEntregaDatetimeFecha en la que se va a entregar el pedido.
fechaSubidaDatetimeFecha en la que se subió el pedido a la web.
codartString(10)RequiredCódigo de artículo asociado al ítem del pedido. En este campo también se cargan códigos especiales: .002xx códigos de motivos de no compra · .003xx códigos de formas de pago (consultar endpoint de códigos especiales) · .0060 observación (siempre va a tener cargado algo en el campo observación) · 000 corte de boleta (que se puede ignorar si utilizan el Guid, pero aun así registrar como bajado el Id de ese registro).
motCambioString(10)Código del motivo de cambio asociado al ítem del pedido (consultar endpoint de motivos de cambio).
cantString(10)RequiredCantidad del artículo asociado al ítem del pedido. Los números antes del punto son bultos, después del punto unidades. Ejemplos: "30.10", "30.0", "-20.0".
descString(10)RequiredDescuento realizado sobre el ítem del pedido.
listaPString(10)RequiredLista de precios considerada en el pedido.
sinCargoString(10)Cantidad de artículos sin cargo.
obsStringRequiredObservaciones realizadas sobre el pedido.
operacionTipoString(1)Required1: Pedido | 2: Presupuesto | 3: Sin compra | 4: Devolución.
comboCodString(20)Código del combo asociado al ítem del pedido.
comboCantString(20)Cantidad del combo asociado al ítem del pedido.
comboItemCantString(20)Cantidad del ítem del combo asociado al ítem del pedido.
itemCodString(20)Código del ítem del combo asociado al ítem del pedido.
empresaCodString(20)Código de la empresa asociada al pedido.
Respuestas
CódigoSignificado
200Pedidos pendientes (estado 0), paginados según batchSize.
403La API key enviada en X-API-KEY no es válida.
404Falta el header X-API-KEY o la URL es incorrecta.
429Se superó el límite de 30 requests por minuto.
500Error interno del servidor. Reintentar más tarde.
cURL
curl --location 'https://gateway.axum.com.ar/{tenant}/api/v1/pedidos' \
  --header 'X-API-KEY: {tenant-apikey}'
RESPONSE · 200 OK
[
  {
    "id": 11231232,
    "guid": "20240614_164954#1d8ea826-86ca-498e-bfe5-5d43979ae4cb",
    "estado": "0",
    "clienteId": "1000",
    "vendedorId": "02",
    "fechaPedido": "2020-01-06 08:04:12",
    "fechaEntrega": null,
    "codart": "21022",
    "motCambio": "",
    "cant": "1.1",
    "desc": "0",
    "listaP": "4",
    "sinCargo": "0",
    "obs": "",
    "operacionTipo": "1",
    "comboCod": null,
    "comboCant": null,
    "comboItemCant": null,
    "itemCod": null
  }
]