# Get a list of orders

Method : <mark style="color:green;">**GET**</mark>

{% code fullWidth="false" %}

```url
https://os.vucustom.com/api/v1/orders?status=new_order&with_tags=&without_tags=&limit=&since_id=&ids&order_ numbers
```

{% endcode %}

URL Parameters

<table><thead><tr><th width="187">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>status</td><td>Filter orders by their current status. Must be one of VU Custom's standard order statuses. Default = "new_order"</td></tr><tr><td>with_tags</td><td>Comma-separated list of tags to include. Returns orders that have ALL specified tags</td></tr><tr><td>without_tags</td><td>Comma-separated list of tags to exclude. Returns orders that have NONE of the specified tags</td></tr><tr><td>limit</td><td>Maximum number of records to retrieve per request. Cannot exceed 250 which is default.</td></tr><tr><td>since_id</td><td>Show orders after the specified ID. Useful for pagination</td></tr><tr><td>ids</td><td>Comma-separated list of order IDs to retrieve</td></tr><tr><td>order_ numbers</td><td>Comma-separated list of order numbers to retrieve</td></tr></tbody></table>

<details>

<summary>Example Request</summary>

```
https://os.vucustom.com/api/v1/orders?status=new_order&with_tags=&without_tags=&limit=&since_id=&ids&order_ numbers
```

</details>

{% tabs %}
{% tab title="200" %}
**`200 Successful response example`**

```json
{
  "orders": [
    {
      "created_at": "2022-10-31T01:54:56.271Z",
      "currency": "USD",
      "custom_attributes": {},
      "id": 12345,
      "note": "Sample note.",
      "order_date": "2022-10-31T01:54:56.271Z",
      "order_lines": [
        {
          "custom_attributes": {},
          "customer_requested_date": "2024-03-31",
          "estimated_arrival_date": "2024-03-31",
          "ex_factory_date": {
            "current": "2024-03-09",
            "changes": [
              {
                "reason_code": "initial",
                "reason_description": "Initial Value",
                "created_at": "2024-02-23T08:00:40.773Z",
                "estimated_arrival_date": "2024-03-31",
                "ex_factory_date": "2024-03-09"
              }
            ]
          },
          "factory_code": "factory123",
          "id": 12345,
          "line_reference": "59861396",
          "price": 70,
          "product_description": "My Widget",
          "product_id": 12345,
          "quantity": 1,
          "recipe_token": "1609c0e8",
          "sku": "SKU123",
          "status": "new_order",
          "tags": [
            "tag1",
            "tag2"
          ],
          "upc": "UPC123",
          "traveler": "{{base_url}}/api/v1/order_lines/841/traveler_file",
		  "production_files": [
					"{{base_url}}/api/v1/order_lines/841/production_file/DOD_tesst51s22s1_1abf1058_tst.png"
				],
          "fulfillments": [
            {
              "created_at": "2024-03-21T08:31:48.653Z",
              "updated_at": "2024-03-21T08:31:48.653Z",
              "quantity": 1,
              "id": 79,
              "tracking_number": "test1",
              "carrier_name": "test",
              "carrier_code": "test",
              "service_name": "test",
              "service_code": "test",
              "recipient_address_1": "test",
              "recipient_city": "test",
              "recipient_name": "test",
              "recipient_state_region": "test",
              "recipient_country": "test",
              "recipient_postal_code": "test",
              "recipient_phone": "test",
              "weight": 0,
              "width": 0,
              "height": 0,
              "length": 0
            }
          ]
        }
      ],
      "order_number": "ord-12345",
      "purchase_order_number": "po-12345",
      "sales_order_number": "so-12345",
      "ship_method_carrier": "ups",
      "ship_method_code": "ups_standard",
      "ship_method_description": "Standard",
      "ship_to": {
        "account_number": "SHPTO123",
        "address_1": "123 Main St",
        "address_2": "",
        "city": "Ridgewood",
        "company_name": "VU Custom",
        "country": "US",
        "created_at": "2022-10-31T01:54:56.271Z",
        "email": "test@test.com",
        "first_name": "John",
        "id": 12345,
        "last_name": "Smith",
        "phone": "2011231234",
        "postal_code": "07450",
        "state_region": "NJ",
        "updated_at": "2022-10-31T01:54:56.271Z"
      },
      "sold_to": {
        "account_number": "SLDTO123",
        "address_1": "123 Main St",
        "address_2": "",
        "city": "Ridgewood",
        "company_name": "VU Custom",
        "country": "US",
        "created_at": "2022-10-31T01:54:56.271Z",
        "email": "test@test.com",
        "first_name": "John",
        "id": 12345,
        "last_name": "Smith",
        "phone": "2011231234",
        "postal_code": "07450",
        "state_region": "NJ",
        "updated_at": "2022-10-31T01:54:56.271Z"
      },
      "tags": [
        "tag1",
        "tag2"
      ],
      "updated_at": "2022-10-31T01:54:56.271Z"
    }
  ]
}
```

{% endtab %}

{% tab title="401 " %}
**`401 Unauthorized`**

`The client doesn’t have correct authentication credentials.`

```
{
"errors": "[API] Invalid API key or secret (unrecognized login or wrong password)"
}
```

{% endtab %}

{% tab title="403" %}
**`403 Forbidden`**

`The server is refusing to respond. This is typically caused by incorrect access.`
{% endtab %}

{% tab title="404" %}
**`404 Not Found`**

`The requested resource was not found but could be available again in the future.`
{% endtab %}

{% tab title="422" %}
**`422 Unprocessable Entity`**
{% endtab %}

{% tab title="5xx" %}
**`5xx Errors`**

`An internal error occurred in VU Admin.`
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://vu-custom.gitbook.io/vu-custom/admin-api/orders/get-a-list-of-orders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.