Integraciones de pedidos POST

Consultar un pedido de la integración


                    POST /api/integration/get-order

Descripción

Devuelve el estado, las líneas y los totales de un pedido creado por la integración.

Detalles

Busca el pedido por su identificador o por la referencia externa con la que se creó. Muestra el estado del pedido, del pago y del domicilio, con sus líneas, opciones y totales. Una integración solo ve los pedidos que ella misma creó.

Permisos requeridos

orders.integration

Request

Nombre	Tipo	Requerido	Reglas
orderUuid	string	No	min:36 max:36
externalReference	string	No	max:60

Respuesta

Campos que devuelve dentro de data. Nada fuera de esta lista sale en la respuesta.

Campo	Tipo	Descripción
order	object	Encabezado del pedido
order.orderUuid	string Admite vacío	Identificador del pedido; vacío en una simulación
order.orderCode	string Admite vacío	Código corto del pedido; vacío en una simulación
order.externalReference	string	Número del pedido en el sistema de la integración
order.lifecycleStatus	string	Estado del pedido
order.paymentStatus	string	Estado del pago
order.channelCode	string	Canal de venta del pedido
order.fulfillmentUuid	string	Canal de entrega del pedido
order.fulfillmentTypeCode	string	Tipo de canal de entrega
order.notes	string Admite vacío	Nota general del pedido
order.subtotalCents	int	Total de los productos en centavos
order.discountCents	int	Descuento en centavos
order.taxCents	int	Impuestos en centavos
order.tipCents	int	Propina en centavos
order.deliveryFeeCents	int	Costo del envío en centavos
order.grandTotalCents	int	Total a pagar en centavos
order.paidCents	int	Pagado en centavos
order.balanceCents	int	Saldo pendiente en centavos
order.deliveryStatus	string Admite vacío	Estado del domicilio; vacío si no es a domicilio
order.createdAt	datetime	Cuándo se creó el pedido
items	array	Líneas del pedido con su precio cobrado
items[].itemUuid	string	Identificador de la línea
items[].productId	int	Producto de la línea
items[].name	string	Nombre del producto
items[].qty	decimal	Cantidad
items[].unitPriceCents	int	Precio unitario en centavos
items[].modifiersTotalCents	int	Opciones por unidad en centavos
items[].priceCents	int	Total de la línea en centavos
items[].lifecycleStatus	string	Estado de la línea
items[].note	string Admite vacío	Nota de la línea
itemModifiers	array	Opciones elegidas en las líneas
itemModifiers[].itemUuid	string	Línea a la que pertenece la opción
itemModifiers[].modifierId	int	Identificador de la opción
itemModifiers[].name	string	Nombre de la opción
itemModifiers[].quantity	decimal	Cantidad de la opción
itemModifiers[].unitPriceCents	int	Precio de la opción en centavos
itemModifiers[].totalCents	int	Total de la opción en centavos

Ejemplo de request

curl -X POST https://restofy.pro/api/integration/get-order \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <accessToken>"

Los valores son demo: reemplázalos por datos reales del negocio.

Ejemplo de respuesta

Actualizado: 2026-11-02T19:00:57Z

HTTP 200

Request

{
    "orderUuid": "aa14cdda-ff0a-4a77-92ad-93a7e7ec7d1e"
}

Response

{
    "success": true,
    "message": "Operación realizada correctamente",
    "data": {
        "order": {
            "orderUuid": "aa14cdda-ff0a-4a77-92ad-93a7e7ec7d1e",
            "orderCode": "52X-A78",
            "externalReference": "WEB-79D66E39",
            "lifecycleStatus": "open",
            "paymentStatus": "unpaid",
            "channelCode": "channel.staff.pos",
            "fulfillmentUuid": "03c84bbb-d113-11f1-8bb6-de64ef616b7c",
            "fulfillmentTypeCode": "fulfillment.takeout",
            "notes": null,
            "subtotalCents": 2300000,
            "discountCents": 0,
            "taxCents": 0,
            "tipCents": 0,
            "deliveryFeeCents": 0,
            "grandTotalCents": 2300000,
            "paidCents": 0,
            "balanceCents": 2300000,
            "deliveryStatus": null,
            "createdAt": "2026-11-02T18:34:06.000Z"
        },
        "items": [
            {
                "itemUuid": "2e626ac3-c466-47cf-9cd6-ab817b299fd9",
                "productId": 9,
                "name": "Cazuela de Mariscos",
                "qty": "1.0000",
                "unitPriceCents": 2300000,
                "modifiersTotalCents": 0,
                "priceCents": 2300000,
                "lifecycleStatus": "confirmed",
                "note": null
            }
        ],
        "itemModifiers": []
    }
}

HTTP 400

Request

{
    "externalReference": "WEB-12345"
}

Response

{
    "success": false,
    "message": "Acción no encontrada.",
    "data": []
}

Volver a Integraciones de pedidos