Get a list of orders

Method : GET

https://admin.vucustom.com/api/:api_version/orders?id=&order_number=TEST45

URL Parameters

Field Name
Description

status

Filter orders by their current status. Must be one of VU Custom's standard order statuses. Default = "new_order"

with_tags

Comma-separated list of tags to include. Returns orders that have ALL specified tags

without_tags

Comma-separated list of tags to exclude. Returns orders that have NONE of the specified tags

limit

Maximum number of records to retrieve per request. Cannot exceed 250 which is default.

since_id

Show orders after the specified ID. Useful for pagination

ids

Comma-separated list of order IDs to retrieve

order_ numbers

Comma-separated list of order numbers to retrieve

Example Request
curl --location 'https://admin.vucustom.com/api/:api_version/orders?status=&with_tags=&without_tags=&limit=&since_id=&ids=null&order_%20numbers=null'

200 Successful response example

{
  "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",
          "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"
      ],
      "b2b": {
        "individual": {
          "id": 1,
          "first_name": "test",
          "last_name": "test",
          "email": "test@test.com",
          "city": "Test",
          "state_region": "TT",
          "postal_code": "13112",
          "country": "US"
        },
        "organization": {
          "id": 1,
          "name": "test",
          "organization_group": {
            "LEAGUE": {
              "Professional": "PRO1"
            }
          }
        },
        "customer": {
          "id": 1,
          "name": "test"
        }
      },
      "updated_at": "2022-10-31T01:54:56.271Z"
    }
  ]
}

Last updated