Obtener pedidos / ordenes
Documentación del Endpoint: pedidos
pedidosURL del Endpoint
GET https://sitio.com/api/pedidos?apikey={apikey}&page={Number}Parámetros de la Solicitud
La solicitud debe incluir los siguientes parámetros en la URL:
apikey (string, requerido): Tu clave API para autenticar la solicitud.
page (int, opcional): Número de página para paginación.
Ejemplo de Solicitud
GET https://sitio.com/api/pedidos?apikey=your_api_key&page=1Respuesta Exitosa
En caso de éxito, se devolverá un JSON con los detalles de los pedidos.
Campos de Respuesta
total_orders (int): Número total de pedidos.
orders (array): Lista de pedidos.
order_id (int): ID del pedido.
user_id (int): ID del usuario que realizó el pedido.
product_details (array): Detalles de los productos en el pedido.
id (int): ID del detalle del pedido.
order_id (int): ID del pedido.
seller_id (int): ID del vendedor.
buyer_id (int): ID del comprador.
buyer_type (string): Tipo de comprador (registrado o invitado).
product_id (int): ID del producto.
product_type (string): Tipo de producto (físico o digital).
listing_type (string): Tipo de listado (venta en el sitio, etc.).
product_title (string): Título del producto.
product_slug (string): Slug del producto.
product_unit_price (int): Precio unitario del producto en la moneda base.
product_quantity (int): Cantidad del producto.
product_currency (string): Moneda del producto.
product_vat_rate (int): Tasa de IVA del producto.
product_vat (int): IVA del producto.
product_total_price (int): Precio total del producto en la moneda base.
variation_option_ids (string): IDs de las opciones de variación del producto.
commission_rate (int): Tasa de comisión.
order_status (string): Estado del pedido.
is_approved (int): Indica si el pedido está aprobado.
shipping_tracking_number (string): Número de seguimiento del envío.
shipping_tracking_url (string): URL de seguimiento del envío.
shipping_method (string): Método de envío.
seller_shipping_cost (int): Costo de envío del vendedor.
updated_at (string): Fecha de última actualización.
created_at (string): Fecha de creación.
order_status (int): Estado del pedido.
payment_method (string): Método de pago.
shipping_details (object): Detalles del envío.
id (int): ID del detalle de envío.
order_id (int): ID del pedido.
shipping_first_name (string): Nombre del destinatario.
shipping_last_name (string): Apellido del destinatario.
shipping_email (string): Correo electrónico del destinatario.
shipping_phone_number (string): Número de teléfono del destinatario.
shipping_address (string): Dirección de envío.
shipping_country (string): País de envío.
shipping_state (string): Estado de envío.
shipping_city (string): Ciudad de envío.
shipping_zip_code (string): Código postal de envío.
billing_first_name (string): Nombre del facturador.
billing_last_name (string): Apellido del facturador.
billing_email (string): Correo electrónico del facturador.
billing_phone_number (string): Número de teléfono del facturador.
billing_address (string): Dirección de facturación.
billing_country (string): País de facturación.
billing_state (string): Estado de facturación.
billing_city (string): Ciudad de facturación.
billing_zip_code (string): Código postal de facturación.
total_amount (int): Monto total del pedido en la moneda base.
price_currency (string): Moneda del monto total.
order_date (string): Fecha del pedido.
Ejemplo de Respuesta
{
"total_orders": 53,
"orders": [
{
"order_id": "10059",
"user_id": "1",
"product_details": [
{
"id": "71",
"order_id": "10059",
"seller_id": "1",
"buyer_id": "1",
"buyer_type": "registered",
"product_id": "3",
"product_type": "physical",
"listing_type": "sell_on_site",
"product_title": "Un zapato (color: rojo, Talle: XL)",
"product_slug": "un-zapato-3",
"product_unit_price": "100",
"product_quantity": "1",
"product_currency": "UYU",
"product_vat_rate": "0",
"product_vat": "0",
"product_total_price": "100",
"variation_option_ids": "a:2:{i:0;s:1:\"3\";i:1;s:2:\"12\";}",
"commission_rate": "0",
"order_status": "payment_received",
"is_approved": "0",
"shipping_tracking_number": "",
"shipping_tracking_url": "",
"shipping_method": "Local Pickup",
"seller_shipping_cost": "0",
"updated_at": "2024-08-04 12:17:14",
"created_at": "2024-08-04 12:17:14"
}
],
"order_status": "0",
"payment_method": "Bamboo",
"shipping_details": {
"id": "59",
"order_id": "10059",
"shipping_first_name": "Juan",
"shipping_last_name": "test",
"shipping_email": "[email protected]",
"shipping_phone_number": "09999",
"shipping_address": "calle falsa 123",
"shipping_country": "Uruguay",
"shipping_state": "Montevideo",
"shipping_city": "montevideo",
"shipping_zip_code": "11600",
"billing_first_name": "Juan",
"billing_last_name": "test",
"billing_email": "[email protected]",
"billing_phone_number": "09999",
"billing_address": "calle falsa 123",
"billing_country": "Uruguay",
"billing_state": "Montevideo",
"billing_city": "montevideo",
"billing_zip_code": "11600"
},
"total_amount": "100",
"price_currency": "UYU",
"order_date": "2024-08-04 12:17:14"
}
]
}Respuesta de Error
En caso de error, se devolverá un JSON con un mensaje de error y un código de estado HTTP correspondiente.
Ejemplo de Respuesta de Error
{
"error": "Invalid API Key"
}Notas Adicionales
Autenticación: Asegúrate de que el API Key proporcionado sea válido.
Campos del Pedido: Todos los campos de los pedidos devueltos en la respuesta son solo para lectura.
Last updated