Recaudo Docs

Tienda

Pedidos

Crea y administra pedidos para tus clientes. Al crear un pedido se generan automáticamente una factura y una liga de pago. Los precios se toman del catálogo de productos.

Listar pedidos

GET /v1/orders

Parámetros opcionales: status, payment_status, customer (UUID), search, limit, page

Estado: pending, confirmed, processing, shipped, delivered, completed, canceled, refunded

Estado del pago: pending, paid, partially_paid, refunded

Crear pedido

POST /v1/orders
Cuerpo
{
  "customer_id": "uuid-del-cliente",
  "items": [
    { "product_id": "uuid-producto-1", "quantity": 2 },
    { "product_id": "uuid-producto-2", "quantity": 1 }
  ],
  "notes": "Entregar antes de las 5pm",
  "shipping_name": "Juan Pérez",
  "shipping_phone": "+5215512345678",
  "shipping_address": "Av. Reforma 123, CDMX"
}
Campo Tipo Requerido Descripción
customer_iduuidSíUUID del cliente
itemsarraySíLista de productos con product_id y quantity
notesstringNoNotas visibles para el cliente
internal_notesstringNoNotas internas
currencystringNoMoneda ISO 4217
shipping_namestringNoNombre del destinatario
shipping_phonestringNoTeléfono del destinatario
shipping_addressstringNoDirección de envío
metadataobjectNoMetadatos personalizados

Obtener pedido

GET /v1/orders/{'{id}'}

Incluye cliente, items con productos y factura asociada.

Ciclo de vida del pedido

POST /v1/orders/{'{id}'}/cancel — Cancelar pedido (restaura stock)
POST /v1/orders/{'{id}'}/ship — Marcar como enviado
POST /v1/orders/{'{id}'}/deliver — Marcar como entregado
POST /v1/orders/{'{id}'}/complete — Marcar como completado

Flujo típico: pending → confirmed → shipped → delivered → completed

Artículos del pedido

GET /v1/orders/{'{id}'}/items

Regresa los artículos del pedido con el detalle de cada producto.

¿Te sirvió esta página? Gracias por avisarnos.
Esc