Obtener órdenes por filtro

Con esta opción accederás a una lista de órdenes asociadas a una cuenta, que podrás filtrar fácilmente.

El estado de las órdenes podrá variar entre los siguientes ítems:

Estado	Descripción
APPROVED	El pago fue exitoso y se desembolsó el dinero a la persona en su cuenta de Ualá.
PENDING	Se crea la orden y está pendiente el pago.
PROCESSED	La orden fue procesada exitosamente y está pendiente su desembolso.
REJECTED	El pago de la orden fue rechazado por algún motivo.

Solo aquellas órdenes con estado APPROVED tendrán los campos taxes y commissions con valores asociados.

BASE_URL:

https://checkout.developers.ar.ua.la/v2/api/orders/

¡Aviso importante! Para usar este endpoint necesitas un token de autorización.

Filtros

Campo	Tipo	Descripción	Requerido	Valor por defecto
limit	Query string	Cantidad límite de órdenes a retornar.	No	10
fromDate	Query string	Fecha de creación de las órdenes desde la cuál se empezará a buscar.	No	No tiene
toDate	Query string	Fecha de creación de las órdenes hasta donde se buscará.	No	No tiene

⚠️

En el caso de no especificarse un límite, se devolverán 10 órdenes por defecto.

Parámetros

Los filtros podrán usarse en conjunto o no.

A continuación, ejemplificamos una consulta con límite y búsqueda por fecha de creación de orden:

GET {BASE_URL}/?limit=100&fromDate=2022-08-04&toDate=2022-08-09

Headers	Tipo	Descripción
Authorization	Bearer	Token de autorización.

Respuestas

Respuestas exitosas

{
  "last_search_key": "aaaa",
  "has_more_items": true || false,
  "orders": [
      {
        "uuid": "1e67ef7d-1f91-47f9-ac8b-d1db46160d4f",
        "status": "APPROVED/PENDING/PROCESSED/REJECTED",
        "external_reference": "idIntegration",
        "amount": 3236,
        "taxes": [
              {
                "percentage": "",
                "held_tax": "",
                "type": "",
              },
              {...},
        ],
        "commissions": [
            {
              "amount": "",
              "percentage": "",
              "type": "",
            },
            {...},
        ],
        "customer": {
          "name": "",
          "card": {
            "holder_name": "",
            "issuer": "",
            "pan": "4500XXXXXXXX9888",
            "installments": {
              "number": 1,
              "total": 3236,
              "value_per_installment": 3236,
              "financial_cost": 0
            }
          }
        },
        "changelog": [
          {
            "new_status": "PENDING",
            "old_status": "",
            "updated_date":"2023-04-26T13:55:27Z"
          },
          {...},
        ],
        "created_date": "2022-09-13T20:00:19.861Z",
        "updated_date": "2022-09-13T20:00:46Z"
      },
      {...}
  ]
}

Campo	Tipo	Descripción
last_search_key	string	Token que le permite a la integración volver a realizar request sobre el endpoint para obtener siguientes órdenes paginadas.
has_more_items	boolean	Valor booleano que determina si hay mas items a retornar.
orders	Array Object	Array de órdenes.

Campo orders:

Campo	Tipo	Descripción
uuid	string	Identificador único de la orden.
status	string	Estado actual de la orden.
external_reference	string	Número de referencia de la orden.
amount	float	Monto de la orden.
taxes	Array Object	Taxes asociados a una orden.
commissions	Array Object	Comisiones asociados a una orden.
customer	Object	Información de la persona que pagó la orden .
changelog	array	Cambios que ocurren sobre una orden.
created_date	string	Fecha de creación de la orden.
updated_date	string	Fecha de actualización de la orden.

Campos:

Campo	Tipo	Descripción
percentage	string	porcentaje de tax aplicado.
held_tax	string	monto retenido.
type	string	tipo de impuesto.

Respuestas de error

Campo	Tipo	Descripción
code	string	Código de error.
message	string	Descripción del error.
errors	string	Errores encontrados.

{
    "code": "request_error",
    "message": "Invalid query string request payload.",
    "errors": [
        "The limit must be less than 50.",
        "Provide a valid sort order (Ex: ascending or descending).",
        "Provide a valid status.",
        "Provide a valid from_date (Ex: YYYY-MM-DD).",
        "Provide a valid to_date (Ex: YYYY-MM-DD).",
        "Provide a valid last_search_key."
    ]
}

Casos de uso Casos de uso