Order
El objeto Order representa un pedido realizado a la tienda.
Con la API de Orders puedes obtener los datos de los pedidos realizados en la tienda.
Acciones disponibles
GET
/admin/orders.json
Obtener una lista de todos los pedidos registrados en la tienda.
GET
/admin/orders/count.json
Consultar el número de pedidos registrados en la tienda.
GET
/admin/orders/:id.json
Obtener las propiedades del pedido :id.
Propiedades de un pedido (order)
| Propiedad | Descripción | Ejemplo |
|---|---|---|
| id | Identificador único para el pedido en tiendy. | { "id": "186597" } |
| lang | Idioma en el que se realizó el pedido (código ISO 639-1). | { "lang": "es" } |
| name | Identificador del pedido según el formato configurado en la tienda. | { "name": "P2015 #10092" } |
| number | Número de pedido de la tienda (números correlativos comenzando desde el número 1000). | { "number": "1001" } |
| status | Estado del pedido ('open', 'closed', 'abandoned', 'cancelled'). | { "status": "open" } |
| payment_status | Estado del pago ('paid','pending','authorized','abandoned','denied'). | { "payment_status": "paid" } |
| payment_method | Forma de pago elegida por el cliente | { "payment_method": "Tarjeta de crédito" } |
| line_items | Productos incluidos en el pedido. | |
| fulfillment_status | Estado del envío ('shipped', 'partial', 'not shipped'). | { "fulfillment_status": "not shipped" } |
| subtotal_price | Precio total sin incluir gastos de envío, impuestos o recargos. | { "subtotal_price": "39.45" } |
| total_price | Precio total incluyendo gastos de envío, impuestos o recargos. | { "total_price": "69.50" } |
| total_tax | Importe correspondiente a los impuestos. | { "total_tax": "9.50" } |
| total_shipping | Importe correspondiente a los gastos de envío. | { "total_shipping": "4.50" } |
| total_discounts | Importe correspondiente a los descuentos aplicados al pedido. | { "total_discounts": "4.50" } |
| total_surcharge | Importe correspondiente a los recargos aplicados al pedido. | { "total_surcharge": "2.50" } |
| customer | Datos del cliente (facturación). | { "customer": { "first_name": "Antonio", "last_name": "Lopez Perez", "company": "Tiendy", "vat": null, "street": "C\/ del amor hermoso nº 9. ", "city": "Málaga", "province": "Malaga", "zip": "29001", "country_code": "ES", "phone": "669 519 463", "accepts_marketing": "0", "email": "antonio@lopezperez.com" } } |
| delivery | Datos de envío. | { "delivery": { "first_name": "Antonio", "last_name": "Lopez Perez", "company": "Tiendy", "vat": null, "street": "C\/ del amor hermoso nº 9. ", "city": "Málaga", "province": "Malaga", "zip": "29001", "country_code": "ES", "phone": "669 519 463", "accepts_marketing": "0", "email": "antonio@lopezperez.com" } } |
| remote_ip | Dirección IP del cliente que ha realizado el pedido. | { "remote_ip": "173.194.45.216" } |
| browser_user_agent | Identificador del navegador que se ha usado para realizar el pedido. | { "browser_user_agent": "Mozilla\/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit\/537.36 (KHTML, like Gecko) Chrome\/38.0.2125.24 Safari\/537.36" } |
| landing_page | Página por la que entró a la tienda el cliente. | { "landing_page": "http://mitienda.mitiendy.com/productos/zapato-verde" } |
| referer | Página donde estaba el enlace en el que el cliente hizo click para llegar a nuestra tienda. | { "referer": "http://blog-tematico.com/articulo-sobre-mitienda" } |
| created_at | Fecha de creación del pedido. | { "created_at": "2014-09-01 13:45:20" } |
| purchased_at | Fecha/hora de finalización del pedido. | { "purchased_at": "2014-09-01 13:45:20" } |
Campos de line_items
Productos incluidos en el pedido.
{
"line_items": {
"533": {
"id": "533",
"order_id": "283",
"product_id": "5",
"quantity": "1",
"requires_shipping": "1",
"sku": "",
"title": "Bolsa de deporte",
"variant_id": "974",
"variant_title": null,
"vendor": null,
"name": "Bolsa de deporte - Super",
"weight": null,
"fulfillable_quantity": "1",
"created_at": null,
"updated_at": null
},
"534": {
"id": "534",
"order_id": "283",
"product_id": "423",
"quantity": "2",
"requires_shipping": "1",
"sku": "",
"title": null,
"variant_id": "493",
"variant_title": null,
"vendor": null,
"name": "prueba bandera - Especial",
"weight": null,
"fulfillable_quantity": "2",
"created_at": null,
"updated_at": null
}
}
}Cada elemento se compone de los siguientes campos:
| Propiedad | Descripción |
|---|---|
| id | Id del elemento |
| product_id | Identificador del producto al que hace referencia |
| quantity | Unidades del producto |
| requires_shipping | Indica si el producto requiere ser enviado |
| sku | Identificador de almacén del producto (Stock Keeping Unit) |
| title | Nombre del producto |
| variant_id | Identificador de la variante |
| variant_title | Nombre de la variante |
| vendor | Fabricante |
| name | Nombre del producto + nombre de la variante |
| fulfillable_quantity | Número de unidades pendiente de envío |