Saltar al contenido principal

Órdenes

Una orden se crea cuando un cliente completa el proceso de compra. También puede generarse manualmente a través de la API.


Propiedades

PropiedadDescripción
idIdentificador único de la orden
numberNúmero de la orden
statusEstado general (open, cancelled, closed)
payment_statusEstado del pago (paid, pending, voided)
shipping_statusEstado del envío (unpacked, packaged, shipped, delivered)
totalTotal de la orden (incluye envío y descuentos)
subtotalSubtotal de la orden
currencyTipo de moneda
created_atFecha de creación (ISO 8601)
updated_atFecha de última actualización (ISO 8601)
noteNota asociada a la orden
tracking_linkLink de seguimiento
payment_gateway_idId de la pasarela de pago
payment_gateway_titleTítulo de la pasarela de pago
customerInformación del cliente
billDatos de facturación del comprador
shipmentDatos de envío del comprador
productsProductos incluidos en la orden

Endpoints

GET /orders

Obtiene una lista de órdenes.

Parámetros de query

ParámetroDescripción
qBuscar por cliente, email o identificación
pageNúmero de página
per_pageCantidad de resultados
statusEstado general
payment_statusEstado del pago
shipping_statusEstado del envío
emailFiltrar por email del cliente
updated_at_fromFecha mínima de actualización (ISO UTC)
updated_at_toFecha máxima de actualización (ISO UTC)

Ejemplo

GET /orders

HTTP/1.1 200 OK

{
"pagination": {
"total": 120,
"page": 1,
"per_page": 50,
"next_page": "https://developers.tiendanegocio.com/v1/orders?page=2&per_page=50"
},
"results": [
{
"id": 40,
"number": 2,
"status": "open",
"total": "250",
"subtotal": "500",
"discount": "750",
"payment_status": "pending",
"payment_title": "Acordar con el vendedor",
"payment_gateway_id": 1,
"payment_gateway_title": "Acordar con el vendedor",
"shipping_status": "unpacked",
"shipping_title": "Envío por moto",
"shipping_cost": "500",
"created_at": "2026-05-29T16:57:50.000Z",
"updated_at": "2026-05-29T20:32:08.940Z",
"currency": "ARS",
"note": "",
"tracking_link": "https://...tiendanegocio.com/compra/proceso/orden?hash=MPRCGA5U",
"customer": {
"id": 11,
"name": "nico ",
"email": "nico@gmail.com",
"identification": "1234567",
"location": {
"zip_code": "1874",
"province": "Buenos Aires",
"city": "Wilde",
"department": "",
"street": "calkle",
"street_number": "",
"description": ""
}
},
"bill": {
"id": 40,
"name": "Juan",
"last_name": "Pérez",
"email": "comprador@ejemplo.com",
"dni": "12345678",
"phone": "1112345678",
"direction": "Calle Falsa 123",
"street": "Calle Falsa",
"street_number": "123",
"city": "Wilde",
"department": "1A",
"zip_code": "1874",
"province": "Buenos Aires"
},
"shipment": {
"id": 40,
"name": "Juan",
"last_name": "Pérez",
"email": "comprador@ejemplo.com",
"phone": "1112345678",
"zip_code": "1874",
"province": "Buenos Aires",
"city": "Wilde",
"department": "1A",
"direction": "Calle Falsa 123",
"street": "Calle Falsa",
"street_number": "123",
"description": "Ejemplo de referencia de entrega"
},
"products": [
{
"id": 48,
"product_id": 226,
"variant_id": null,
"name": "Remera Lino",
"quantity": 1,
"price": "500",
"sku": "R-Lino",
"image": "https://cdn...image.webp",
"properties_id": []
}
]
}
]
}

GET /orders/{id}

Obtiene una orden por ID.

Ejemplo

GET /orders/40

HTTP/1.1 200 OK

{
"id": 40,
"number": 2,
"status": "open",
"total": "250",
"subtotal": "500",
"discount": "750",
"payment_status": "pending",
"payment_title": "Acordar con el vendedor",
"payment_gateway_id": 1,
"payment_gateway_title": "Acordar con el vendedor",
"shipping_status": "unpacked",
"shipping_title": "Envío por moto",
"shipping_cost": "500",
"created_at": "2026-05-29T16:57:50.000Z",
"updated_at": "2026-05-29T20:32:08.940Z",
"currency": "ARS",
"note": "",
"tracking_link": "https://...tiendanegocio.com/compra/proceso/orden?hash=MPRCGA5U",
"customer": {
"id": 11,
"name": "nico ",
"email": "nico@gmail.com",
"identification": "1234567",
"location": {
"zip_code": "1874",
"province": "Buenos Aires",
"city": "Wilde",
"department": "",
"street": "calkle",
"street_number": "",
"description": ""
}
},
"bill": {
"id": 40,
"name": "Juan",
"last_name": "Pérez",
"email": "comprador@ejemplo.com",
"dni": "12345678",
"phone": "1112345678",
"direction": "Calle Falsa 123",
"street": "Calle Falsa",
"street_number": "123",
"city": "Wilde",
"department": "1A",
"zip_code": "1874",
"province": "Buenos Aires"
},
"shipment": {
"id": 40,
"name": "Juan",
"last_name": "Pérez",
"email": "comprador@ejemplo.com",
"phone": "1112345678",
"zip_code": "1874",
"province": "Buenos Aires",
"city": "Wilde",
"department": "1A",
"direction": "Calle Falsa 123",
"street": "Calle Falsa",
"street_number": "123",
"description": "Ejemplo de referencia de entrega"
},
"products": [
{
"id": 48,
"product_id": 226,
"variant_id": null,
"name": "Remera Lino",
"quantity": 1,
"price": "500",
"sku": "R-Lino",
"image": "https://cdn...image.webp",
"properties_id": []
}
]
}

POST /orders

Crea una nueva orden.

Products

ParámetroDescripción
product_idID del producto
variant_idID de la variante (opcional)
quantityCantidad

Shipment (opcional)

ParámetroDescripción
nameNombre del receptor
last_nameApellido del receptor
emailEmail del receptor
phoneTeléfono del receptor
shipment_titleTítulo del envío
zip_codeCódigo postal
provinceProvincia
cityCiudad
departmentDepartamento
directionDirección
streetCalle
street_numberNúmero
descriptionDescripción

Bill

ParámetroDescripción
dniDNI
nameNombre
last_nameApellido
emailEmail
phoneTeléfono
directionDirección
streetCalle
street_numberNúmero
cityCiudad
departmentDepartamento
zip_codeCódigo postal
provinceProvincia

Ejemplo de request

{
"note": "nota de venta",
"payment_title": "Mercado Pago",
"shipment_title": "Envío a domicilio",
"products": [
{
"product_id": 1,
"variant_id": 0,
"quantity": 2
}
],
"shipment": {
"name": "María",
"last_name": "García",
"email": "envio@ejemplo.com",
"phone": "1198765432",
"zip_code": "5000",
"province": "Córdoba",
"city": "Córdoba",
"department": "2B",
"direction": "Calle de ejemplo 456",
"street": "Calle de ejemplo",
"street_number": "456",
"description": "Ejemplo de instrucciones de entrega"
},
"bill": {
"name": "Juan",
"last_name": "Pérez",
"dni": "12345678",
"phone": "1112345678",
"email": "facturacion@ejemplo.com",
"direction": "Calle Falsa 123",
"street": "Calle Falsa",
"street_number": "123",
"city": "Ciudad Autónoma de Buenos Aires",
"department": "3C",
"zip_code": "1425",
"province": "Buenos Aires"
}
}

Respuesta

HTTP/1.1 201 Created

{
"id": 28,
"number": 28,
"status": "open",
"payment_status": "pending",
"payment_title": "Mercado Pago",
"payment_gateway_id": 2,
"payment_gateway_title": "Mercado Pago",
"shipping_status": "unpacked",
"total": "1750",
"subtotal": "1500",
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-01-01T00:00:00.000Z",
"currency": "ARS",
"note": "nota de venta",
"tracking_link": "https://example.tiendanegocio.com/compra/proceso/orden?hash=XXX",
"customer": {
"id": 15,
"name": "Juan",
"email": "juan@gmail.com"
},
"products": [
{
"id": 28,
"product_id": 1,
"variant_id": null,
"name": "Remera lino",
"quantity": 2,
"price": "750",
"sku": "REM-LINO",
"properties_id": []
}
]
}

PUT /orders/{id}

Actualiza una orden existente.

Ejemplo

PUT /orders/28

{
"note": "orden pagada",
"status": "open",
"payment_status": "paid",
"shipping_status": "packaged"
}

Respuesta

HTTP/1.1 200 OK

{
"id": 28,
"number": 28,
"status": "open",
"payment_status": "paid",
"payment_title": "Mercado Pago",
"payment_gateway_id": 2,
"payment_gateway_title": "Mercado Pago",
"shipping_status": "packaged",
"total": "1750",
"subtotal": "1500",
"created_at": "2023-01-01T00:00:00.000Z",
"updated_at": "2023-02-01T00:00:00.000Z",
"currency": "ARS",
"note": "orden pagada",
"tracking_link": "https://example.tiendanegocio.com/compra/proceso/orden?hash=XXX",
"customer": {
"id": 15,
"name": "Juan",
"email": "juan@gmail.com"
},
"products": [
{
"id": 29,
"product_id": 2,
"variant_id": 2,
"name": "Campera (S) (XL)",
"quantity": 2,
"price": "750",
"sku": "CAMP-LINO",
"image": "https://cdn...image.webp",
"properties_id": ["208", "209"]
}
]
}

POST /orders/{id}/invoice

Carga una factura de un pdf en base64

Ejemplo

PUT /orders/2/invoice

{
"invoice_file": "data:application/pdf;base64,`${base64}`"
}

Respuesta

HTTP/1.1 200 OK

{
"order_id": 2,
"invoice_url": "https://cdn.v2.tiendanegocio.com/dev/transactions/1/2/invoice_1779207756355.pdf"
}

DELETE /orders/${id}/invoice

Ejemplo

DELETE /orders/2/invoice

HTTP/1.1 200 OK

{
"order_id": 2,
"message": "Invoice deleted successfully."
}