Cómo gestionar los pedidos vía API
π Más información sobre Pedidos
Obtener todos los pedidos
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/pedidos?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- page: número de página (opcional). Por defecto 1 si no es proporcionado.
- page_size: cantidad de registros a incluir en el resultado (opcional). Por defecto 100 si no es proporcionado (valor máximo).
Opcionalmente se pueden incluir estos valores para refinar la búsqueda:
- fecha_desde: fecha a partir de la cual se quieren obtener pedidos. Formato "YYYY-MM-DD".
- fecha_hasta: fecha hasta la cual se quieren obtener pedidos. Formato "YYYY-MM-DD".
- numero_orden: número que identifica a un pedido.
- estado_pago: uno de los siguientes valores: "pendiente", "pagado", "cancelado".
- estado_envio: uno de los siguientes valores: "no_iniciado", "iniciado", "listo", "enviado", "entregado", "cancelado", "devuelto".
- usuario_codigo: código que identifica al usuario comprador.
- usuario_email: dirección de correo del usuario comprador.
- usuario_documento_identidad: número de DNI, CI, CC, etc. del comprador.
- usuario_identificador_tributario: número de CUIT, RUT, RUC, RFC, etc. del comprador.
Respuesta:
Lista de pedidos.
Ejemplo:
{
"result": {
"count": "3",
"items": [
{
"numero_orden": "158",
"moneda": "ars",
"lista_precios_codigo": "MIN",
"total": "62.5",
"total_articulos": "30",
"estado_pago": "pendiente",
"forma_pago": "contra_reembolso",
"forma_pago_recargo": "0.00",
"estado_envio": "no_iniciado",
"forma_envio": "entrega_a_domicilio",
"forma_envio_recargo": "50.00",
"cupon_codigo": "descuento_50",
"cupon_descuento": "7.50",
"impuesto_nombre": "",
"impuesto_recargo": "0.00",
"costo_nombre": "",
"costo_recargo": "0.00",
"promocion_descuento": "15.00",
"fecha": "2023-02-22 10:14:12",
"fecha_pago": "",
"fecha_cancelacion": "",
"arrepentido": "0",
"usuario_codigo": "USU-01",
"usuario_nombre": "Juan",
"usuario_apellido": "Pérez",
"usuario_email": "jperez@webered.com",
"usuario_documento_identidad": "12345",
"usuario_identificador_tributario": "56789",
"destino_otra_persona": "0",
"destino_nombre": "Juan",
"destino_apellido": "Pérez",
"destino_telefono": "123456789",
"destino_telefono_pais": "54",
"destino_direccion": "Calle 123",
"destino_codigo_postal": "7600",
"destino_localidad": "Mar del Plata",
"destino_provincia": "Buenos Aires",
"destino_pais": "Argentina",
"destino_observaciones": "Tocar timbre y esperar"
},
{
"numero_orden": "157",
"moneda": "ars",
"lista_precios_codigo": "MIN",
"total": "12.5",
"total_articulos": "10",
"estado_pago": "pagado",
"forma_pago": "mercadopago",
"forma_pago_recargo": "2.50",
"estado_envio": "no_iniciado",
"forma_envio": "retiro_en_local",
"forma_envio_recargo": "0.00",
"cupon_codigo": "",
"cupon_descuento": "0.00",
"impuesto_nombre": "",
"impuesto_recargo": "0.00",
"costo_nombre": "",
"costo_recargo": "0.00",
"promocion_descuento": "0.00",
"fecha": "2023-01-06 17:53:42",
"fecha_pago": "2023-01-06 17:54:22",
"fecha_cancelacion": "",
"arrepentido": "0",
"usuario_codigo": "USU-01",
"usuario_nombre": "Juan",
"usuario_apellido": "Pérez",
"usuario_email": "jperez@webered.com",
"usuario_documento_identidad": "12345",
"usuario_identificador_tributario": "56789",
"destino_otra_persona": "0",
"destino_nombre": "Juan",
"destino_apellido": "Pérez",
"destino_telefono": "123456789",
"destino_telefono_pais": "54",
"destino_direccion": "Calle 123",
"destino_codigo_postal": "7600",
"destino_localidad": "Mar del Plata",
"destino_provincia": "Buenos Aires",
"destino_pais": "Argentina",
"destino_observaciones": ""
},
{
"numero_orden": "156",
"moneda": "ars",
"lista_precios_codigo": "MIN",
"total": "5000",
"total_articulos": "10000",
"estado_pago": "pendiente",
"forma_pago": "contra_reembolso",
"forma_pago_recargo": "0.00",
"estado_envio": "no_iniciado",
"forma_envio": "correo_personalizado",
"forma_envio_recargo": "0.00",
"cupon_codigo": "",
"cupon_descuento": "0.00",
"impuesto_nombre": "",
"impuesto_recargo": "0.00",
"costo_nombre": "",
"costo_recargo": "0.00",
"promocion_descuento": "5000.00",
"fecha": "2023-01-05 11:52:42",
"fecha_pago": "",
"fecha_cancelacion": "",
"arrepentido": "0",
"usuario_codigo": "USU-01",
"usuario_nombre": "Juan",
"usuario_apellido": "Pérez",
"usuario_email": "jperez@webered.com",
"usuario_documento_identidad": "12345",
"usuario_identificador_tributario": "56789",
"destino_otra_persona": "0",
"destino_nombre": "Juan",
"destino_apellido": "Pérez",
"destino_telefono": "123456789",
"destino_telefono_pais": "54",
"destino_documento_identidad": "123456789",
"destino_direccion": "Calle 123",
"destino_codigo_postal": "7600",
"destino_localidad": "Mar del Plata",
"destino_provincia": "Buenos Aires",
"destino_pais": "Argentina",
"destino_observaciones": ""
}
]
}
}
Obtener la cantidad de pedidos
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/pedidos/count?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Cantidad de pedidos en formato JSON.
Ejemplo:
{
"result": {
"count": "260"
}
}
Obtener un pedido
URL:
https://{DOMINIO DEL SITIO WEB}/pw/api/pedidos/{NUMERO ORDEN}?apikey={CLAVE DE API}
Método HTTP:
GET
Parámetros:
- Ninguno.
Respuesta:
Datos de un pedido.
Ejemplo:
{
"result": {
"item": {
"numero_orden": "158",
"total": "62.5",
"total_articulos": "60",
"estado_pago": "pendiente",
"forma_pago": "contra_reembolso",
"forma_pago_recargo": "0.00",
"estado_envio": "no_iniciado",
"forma_envio": "entrega_a_domicilio",
"forma_envio_recargo": "50.00",
"cupon_codigo": "descuento_50",
"cupon_descuento": "7.50",
"impuesto_nombre": "",
"impuesto_recargo": "0.00",
"costo_nombre": "",
"costo_recargo": "0.00",
"promocion_descuento": "20.00",
"fecha": "2023-02-22 10:14:12",
"fecha_pago": "",
"fecha_cancelacion": "",
"arrepentido": "0",
"usuario_codigo": "USU-01",
"usuario_nombre": "Juan",
"usuario_apellido": "Pérez",
"usuario_email": "jperez@webered.com",
"usuario_documento_identidad": "12345",
"usuario_identificador_tributario": "56789",
"destino_otra_persona": "0",
"destino_nombre": "Juan",
"destino_apellido": "Pérez",
"destino_telefono": "123456789",
"destino_telefono_pais": "54",
"destino_direccion": "Calle 123",
"destino_codigo_postal": "7600",
"destino_localidad": "Mar del Plata",
"destino_provincia": "Buenos Aires",
"destino_pais": "Argentina",
"destino_observaciones": "Tocar timbre y esperar",
"moneda": "ars",
"lista_precios_codigo": "MIN",
"detalle": {
"count": "4",
"count_articulos": "3",
"count_promociones": "1",
"items": [
{
"tipo": "articulo",
"producto_nombre": "Producto 1",
"producto_codigo": "P1",
"variante1_nombre": "mediano",
"variante1_codigo": "TAM-MEDIANO",
"variante2_nombre": "azul",
"variante2_codigo": "COL-AZUL",
"cantidad": "1",
"precio": "10.00",
"peso": "2000",
"volumen": "8000",
"promocion_descripcion": ""
},
{
"tipo": "articulo",
"producto_nombre": "Producto 1",
"producto_codigo": "P1",
"variante1_nombre": "grande",
"variante1_codigo": "TAM-GRANDE",
"variante2_nombre": "rojo",
"variante2_codigo": "COL-ROJO",
"cantidad": "1",
"precio": "10.00",
"peso": "2000",
"volumen": "8000",
"promocion_descripcion": ""
},
{
"tipo": "articulo",
"producto_nombre": "Producto 2",
"producto_codigo": "P2",
"variante1_nombre": "chico",
"variante1_codigo": "TAM-CHICO",
"variante2_nombre": "azul",
"variante2_codigo": "COL-AZUL",
"cantidad": "4",
"precio": "10.00",
"peso": "2000",
"volumen": "8000",
"promocion_descripcion": ""
},
{
"tipo": "promocion",
"producto_nombre": "Producto 2",
"producto_codigo": "P2",
"variante1_nombre": "chico",
"variante1_codigo": "TAM-CHICO",
"variante2_nombre": "",
"variante2_codigo": "",
"cantidad": "1",
"precio": "-20.00",
"peso": "0",
"volumen": "0",
"promocion_descripcion": "50% de descuento comprando 3 o más unidades"
}
]
}
}
}
}
Descripción de los valores incluidos en las respuestas:
"numero_orden":
Número que identifica al pedido.
"moneda":
Código de la moneda en que se hizo la compra.
Valores posibles: "ars", "usd", "eur", "clp", "cop", "mxn", "pen", "pyg", "uyu".
"lista_precios_codigo":
Código de la lista de precios utilizada durante la compra.
"total":
Importe final que resulta de aplicar recargos, descuentos y promociones.
"total_articulos":
Importe total de los artículos.
"estado_pago":
Estado del pedido.
Valores posibles: "pendiente", "pagado", "cancelado".
"forma_pago":
Método de pago seleccionado durante la compra.
Valores posibles: "paypal", "mercadopago", "rapipago", "contra_reembolso", "no_especificada", "transferencia_bancaria", "personalizada", "gocuotas", "stripe", "pagopar", "handy".
"forma_pago_recargo":
Recargo que se aplica según el método de pago seleccionado.
Puede ser un número negativo y en ese caso se aplica como un descuento.
"estado_envio":
Estado de envío del pedido.
Valores posibles: "no_iniciado", "iniciado", "listo", "enviado", "entregado", "cancelado", "devuelto".
"forma_envio":
Método de envío seleccionado durante la compra.
Valores posibles: "retiro_en_local", "entrega_a_domicilio", "correo_personalizado", "oca", "correo_argentino", "andreani".
"forma_envio_recargo":
Recargo que se aplica según el método de envío seleccionado.
"cupon_codigo":
Cupón de descuento cargado durante la compra.
"cupon_descuento":
Importe del descuento obtenido con un cupón.
"impuesto_nombre":
Nombre del impuesto aplicado al total de la compra.
"impuesto_recargo":
Recargo que resulta de aplicar un porcentaje de impuestos al total de la compra.
"costo_nombre":
Nombre del costo fijo aplicado al total de la compra.
"costo_recargo":
Monto del costo fijo aplicado a la compra.
"promocion_descuento":
Importe total de las promociones aplicadas sobre los artículos.
"fecha":
Fecha en que se realizó la compra.
Formato: "YYYY-MM-DD H:i:s"
"fecha_pago":
Fecha en la que el estado del pedido cambió a "pagado".
Formato: "YYYY-MM-DD H:i:s"
"fecha_cancelacion": "",
Fecha en la que el estado del pedido cambió a "cancelado".
Formato: "YYYY-MM-DD H:i:s"
"arrepentido": "0",
Indica si la cancelación fue realizada por el comprador.
Valores posibles: "0", "1".
"usuario_codigo":
Código que identifica al usuario comprador.
"usuario_nombre":
Nombre del comprador.
"usuario_apellido":
Apellido del comprador.
"usuario_email":
Email del comprador.
"usuario_documento_identidad":
Número de DNI, CI, CC, etc. del comprador.
"usuario_identificador_tributario":
Número de CUIT, RUT, RUC, RFC, etc. del comprador.
"destino_otra_persona":
Indica si los datos de entrega del pedido corresponden a una persona distinta al comprador.
"destino_nombre":
Nombre de la persona a la que se debe entregar el pedido.
"destino_apellido":
Apellido de la persona a la que se debe entregar el pedido.
"destino_telefono":
Teléfono de la persona a la que se debe entregar el pedido.
"destino_telefono_pais":
Código telefónico del país de la persona a la que se debe entregar el pedido.
"destino_direccion":
Dirección de la persona a la que se debe entregar el pedido.
"destino_codigo_postal":
Código postal de la persona a la que se debe entregar el pedido.
"destino_localidad":
Localidad de la persona a la que se debe entregar el pedido.
"destino_provincia":
Provincia de la persona a la que se debe entregar el pedido.
"destino_pais":
País de la persona a la que se debe entregar el pedido.
"destino_observaciones":
Comentarios del comprador referidos a la entrega del pedido.
"detalle":
Información de los artículos incluidos en la compra.
Se incluye solamente cuando se obtienen los datos de un pedido en particular a partir de su número de orden.
Contiene los siguientes valores:
"count":
Cantidad de items en el detalle.
"count_articulos":
Cantidad de artículos incluidos en la compra.
"count_promociones":
Cantidad de promociones incluidas en la compra.
"items":
Lista de ítems con los siguientes valores:
"tipo":
Indica si el ítem es un artículo o una promoción correspondiente a alguno de los artículos.
Valores posibles: "articulo", "promocion".
"producto_nombre":
Nombre del producto comprado.
"producto_codigo":
Código del producto comprado.
"variante1_nombre":
Nombre de la variante 1 del producto.
"variante1_codigo":
Código de la variante 1 del producto.
"variante2_nombre":
Nombre de la variante 2 del producto.
"variante2_codigo":
Código de la variante 2 del producto.
"cantidad":
Cantidad comprada del producto y sus variantes.
Es igual a "1" cuando el campo "tipo" tiene valor "promocion".
"precio":
Precio unitario del producto y sus variantes.
Es un valor negativo cuando el campo "tipo" tiene valor "promocion" y representa el monto que se descuenta.
"peso":
Peso del producto.
"volumen":
Volumen del producto.
"promocion_descripcion":
Descripción de la promoción.
Se aplica solamente cuando el campo "tipo" tiene valor "promocion".
