What is it for?

Returns a list of orders. You can filter by several criteria. All parameters are optional — without parameters it returns all orders.

Conditions

• Requires authentication.

Parameters

Fill in the fields in Query Params and/or Path Params as applicable.

Quick parameter guide

• ids: Filter by specific order IDs (Instructions: The IDs you got when creating orders. Separate with commas: 1,2,3)
• status_ids: Filter by order status (Instructions: Check with your team for the available status IDs. Separate with commas)
• shop_ids: Filter orders from specific shops (Instructions: Call GET /api/v1/client/shops → copy the "id" of the shops you want. Separate with commas)
• payment_method_ids: Filter by payment method (Instructions: Call GET /api/v1/client/payment-methods → copy the "id". Separate with commas)
• courier_ids: Filter by courier (Instructions: Check with your team for the available courier IDs. Separate with commas)
• date[column]: Which date field to use for filtering (Instructions: Write one of these values: order_created_at, processed_at, last_shipment_update)
• date[start]: Start date of the range (Instructions: Formato: 2024-01-01)
• date[end]: End date of the range (Instructions: Formato: 2024-01-31)
• search: Text search (Instructions: Type the reference, ID or tracking number you are looking for)
• product_ids: Filter orders containing those products (Instructions: Call GET /api/v1/client/products → copy the "id". Separate with commas)
• sorting[column]: Field to sort by (Instructions: Possible values: id, ref, order_created_at, processed_at, last_shipment_update)
• sorting[direction]: Ascending or descending order (Instructions: Write: asc or desc)
• per_page: How many orders to show per page (Instructions: An integer. Default is usually 15 or 25)
• page: Which page to view (Instructions: Starts at 1)

Expected response

HTTP 200 → Paginated list of orders with pagination data

Order Status Reference

The status_id field can have the following values:

Note: The description field in the response contains the Spanish text shown above. The status_id and status.id fields share the same numeric domain.

Shipment Status Reference (Normalized)

The fields shipment.status_mapped_id and shipment_status.id use the following normalized values, independent of the courier:

Note: These values may be null when the courier returns a status code that has not yet been mapped internally.

External Financial Status Reference

The external_financial_status field reflects the financial state coming from the external e-commerce platform (Shopify, WooCommerce, MercadoPago). Accepted values:

Note: When sent in a request (POST/PUT), the value is accepted as free string and stored as-is.