# Orders API

The **Orders API** enables seamless aggregation of order data from multiple third-party platforms for clients common to Voosh and its partners. This API provides:

- **Order Details**: Retrieves comprehensive order information from integrated platforms, including order status, timestamps, and itemized breakdowns.
    
- **Financial Insights**: Fetches order-level financial data, offering visibility into revenue, taxes, fees, and other cost components.
    

By consolidating order data across platforms, this API empowers partners to efficiently analyze performance, optimize operations, and ensure accurate financial tracking.

## Get Orders

 - [GET /orders](https://api.voosh.ai/main/orders-api/getorders.md): 
The endpoint retrieves a list of orders based on the provided query parameters. The request includes a limit, offset, and clientId to filter the results. Additionally, the request payload includes a start date, end date, listing IDs, and channel to further refine the search.

### Response
The response for this request is a JSON object with the following structure:




## Get Order Financials

 - [GET /orders/financial](https://api.voosh.ai/main/orders-api/getorderfinancials.md): This endpoint retrieves orders with financial details

#### Request

- Method: GET
    
- URL: {{base-url}}/orders/financial
    
- Query Parameters:
    
    - limit (integer, optional): The maximum number of financial orders to retrieve.
        
    - offset (integer, optional): The offset for pagination.
        
    - clientId (string, required): The unique identifier of the client.
        
- { "startDate": "YYYY-MM-DD", "endDate": "YYYY-MM-DD", "listingIds": \["string"\], "channel": \["string"\] }
    
    - startDate (string): The start date for filtering financial orders.
        
    - endDate (string): The end date for filtering financial orders.
        
    - listingIds (array of strings): The listing IDs to filter financial orders by.
        
    - channel (array of strings): The channels to filter financial orders by.
        

#### Response

The response is a JSON object with the following schema:



## Get Order Details

 - [GET /orders/order-details](https://api.voosh.ai/main/orders-api/getorderdetails.md): This endpoint retrieves the details of a specific order based on the provided query parameters.

#### Request

- Method: GET
    
- URL: {{base-url}}/orders/order-details
    
- Query Parameters:
    
    - clientId (string, required): The unique identifier of the client.
        
    - deliveryUUID (string, required): The unique identifier of the delivery.
        
    - channel (string, required): The channel through which the order was placed.
        

#### Response

The response is a JSON object with the following schema: