Obtener pedidos / ordenes

Documentación del Endpoint: pedidos

URL 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=1

Respuesta 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

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

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